put the issue of using a monitor section into ~/.config/ardour.rc, not the session...
[ardour2.git] / gtk2_ardour / ardour_ui.h
blob47be382f46cebece48f5349944efc77104bc8a57
1 /*
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__
23 #include <time.h>
25 /* need _BSD_SOURCE to get timersub macros */
27 #ifdef _BSD_SOURCE
28 #include <sys/time.h>
29 #else
30 #define _BSD_SOURCE
31 #include <sys/time.h>
32 #undef _BSD_SOURCE
33 #endif
35 #include <list>
36 #include <cmath>
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 "audio_clock.h"
67 #include "ardour_dialog.h"
68 #include "editing.h"
69 #include "ui_config.h"
71 class About;
72 class AddRouteDialog;
73 class ArdourStartup;
74 class ArdourKeyboard;
75 class AudioClock;
76 class BundleManager;
77 class ConnectionEditor;
78 class KeyEditor;
79 class LocationUIWindow;
80 class Mixer_UI;
81 class PublicEditor;
82 class RCOptionEditor;
83 class RouteParams_UI;
84 class SessionOptionEditor;
85 class Splash;
86 class ThemeManager;
88 namespace Gtkmm2ext {
89 class TearOff;
92 namespace ARDOUR {
93 class ControlProtocolInfo;
94 class IO;
95 class Port;
96 class Route;
97 class RouteGroup;
98 class Location;
101 extern sigc::signal<void> ColorsChanged;
102 extern sigc::signal<void> DPIReset;
104 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
106 public:
107 ARDOUR_UI (int *argcp, char **argvp[]);
108 ~ARDOUR_UI();
110 bool run_startup (bool should_be_new);
112 void show ();
113 bool shown() { return shown_flag; }
115 void show_splash ();
116 void hide_splash ();
118 void launch_chat ();
119 void show_about ();
120 void hide_about ();
122 void idle_load (const Glib::ustring& path);
123 void finish();
125 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
126 bool session_loaded;
127 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
128 uint32_t master_chns,
129 ARDOUR::AutoConnectOption input_connect,
130 ARDOUR::AutoConnectOption output_connect,
131 uint32_t nphysin,
132 uint32_t nphysout,
133 nframes_t initial_length);
134 bool session_is_new() const { return _session_is_new; }
136 ARDOUR::Session* the_session() { return _session; }
138 bool will_create_new_session_automatically() const {
139 return _will_create_new_session_automatically;
142 void set_will_create_new_session_automatically (bool yn) {
143 _will_create_new_session_automatically = yn;
146 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false);
147 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
148 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
149 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
150 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
152 /// @return true if session was successfully unloaded.
153 int unload_session (bool hide_stuff = false);
154 void close_session();
156 int save_state_canfail (std::string state_name = "");
157 void save_state (const std::string & state_name = "");
159 static double gain_to_slider_position (ARDOUR::gain_t g);
160 static ARDOUR::gain_t slider_position_to_gain (double pos);
162 static ARDOUR_UI *instance () { return theArdourUI; }
163 static UIConfiguration *config () { return ui_config; }
165 PublicEditor& the_editor(){return *editor;}
166 Mixer_UI* the_mixer() { return mixer; }
168 void toggle_key_editor ();
169 void toggle_location_window ();
170 void toggle_theme_manager ();
171 void toggle_bundle_manager ();
172 void toggle_big_clock_window ();
173 void toggle_route_params_window ();
174 void toggle_editing_space();
176 Gtk::Tooltips& tooltips() { return _tooltips; }
178 static sigc::signal<void,bool> Blink;
179 static sigc::signal<void> RapidScreenUpdate;
180 static sigc::signal<void> SuperRapidScreenUpdate;
181 static sigc::signal<void,nframes_t, bool, nframes_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 (nframes_t position);
192 void halt_on_xrun_message ();
193 void xrun_handler (nframes_t);
194 void create_xrun_marker (nframes_t);
196 AudioClock primary_clock;
197 AudioClock secondary_clock;
198 AudioClock preroll_clock;
199 AudioClock postroll_clock;
201 void store_clock_modes ();
202 void restore_clock_modes ();
203 void reset_main_clocks ();
205 void add_route (Gtk::Window* float_window);
207 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
208 session_add_audio_route (true, false, input_channels, output_channels, mode, route_group, how_many);
211 void session_add_audio_bus (bool aux, int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
212 session_add_audio_route (false, aux, input_channels, output_channels, ARDOUR::Normal, route_group, how_many);
215 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many) {
216 session_add_midi_route (true, route_group, how_many);
219 /*void session_add_midi_bus () {
220 session_add_midi_route (false);
223 int create_engine ();
224 void post_engine ();
226 gint exit_on_main_window_close (GdkEventAny *);
228 void maximise_editing_space ();
229 void restore_editing_space ();
231 void setup_profile ();
232 void setup_theme ();
233 void setup_tooltips ();
235 void set_shuttle_fract (double);
237 protected:
238 friend class PublicEditor;
240 void toggle_clocking ();
241 void toggle_auto_play ();
242 void toggle_auto_input ();
243 void toggle_punch ();
244 void unset_dual_punch ();
245 bool ignore_dual_punch;
246 void toggle_punch_in ();
247 void toggle_punch_out ();
248 void show_loop_punch_ruler_and_disallow_hide ();
249 void reenable_hide_loop_punch_ruler_if_appropriate ();
250 void toggle_auto_return ();
251 void toggle_click ();
253 void toggle_session_auto_loop ();
255 void toggle_rc_options_window ();
256 void toggle_session_options_window ();
258 private:
259 ArdourStartup* _startup;
260 ARDOUR::AudioEngine *engine;
261 Gtk::Tooltips _tooltips;
263 void goto_editor_window ();
264 void goto_mixer_window ();
265 void toggle_editor_mixer_on_top ();
266 bool _mixer_on_top;
268 Gtk::ToggleButton preroll_button;
269 Gtk::ToggleButton postroll_button;
271 int setup_windows ();
272 void setup_transport ();
273 void setup_clock ();
275 static ARDOUR_UI *theArdourUI;
277 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
278 void startup ();
279 void shutdown ();
281 int ask_about_saving_session (const std::string & why);
283 /* periodic safety backup, to be precise */
284 gint autosave_session();
285 void update_autosave();
286 sigc::connection _autosave_connection;
288 void map_transport_state ();
289 int32_t do_engine_start ();
291 void engine_halted ();
292 void engine_stopped ();
293 void engine_running ();
295 void use_config ();
297 static gint _blink (void *);
298 void blink ();
299 gint blink_timeout_tag;
300 bool blink_on;
301 void start_blinking ();
302 void stop_blinking ();
304 void about_signal_response(int response);
306 private:
307 Gtk::VBox top_packer;
309 sigc::connection clock_signal_connection;
310 void update_clocks ();
311 void start_clocking ();
312 void stop_clocking ();
314 void manage_window (Gtk::Window&);
316 AudioClock big_clock;
317 Gtk::Window* big_clock_window;
318 int original_big_clock_width;
319 int original_big_clock_height;
320 double original_big_clock_font_size;
322 void big_clock_size_allocate (Gtk::Allocation&);
323 bool idle_big_clock_text_resizer (int width, int height);
324 void big_clock_realized ();
325 bool big_clock_resize_in_progress;
326 int big_clock_height;
328 void float_big_clock (Gtk::Window* parent);
329 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
331 void update_transport_clocks (nframes_t pos);
332 void record_state_changed ();
334 /* Transport Control */
336 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
337 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
339 Gtkmm2ext::TearOff* transport_tearoff;
340 Gtk::Frame transport_frame;
341 Gtk::HBox transport_tearoff_hbox;
342 Gtk::HBox play_range_hbox;
343 Gtk::VBox play_range_vbox;
344 Gtk::HBox transport_hbox;
345 Gtk::Fixed transport_base;
346 Gtk::Fixed transport_button_base;
347 Gtk::Frame transport_button_frame;
348 Gtk::HBox transport_button_hbox;
349 Gtk::VBox transport_button_vbox;
350 Gtk::HBox transport_option_button_hbox;
351 Gtk::VBox transport_option_button_vbox;
352 Gtk::HBox transport_clock_hbox;
353 Gtk::VBox transport_clock_vbox;
354 Gtk::HBox primary_clock_hbox;
355 Gtk::HBox secondary_clock_hbox;
358 struct TransportControllable : public PBD::Controllable {
359 enum ToggleType {
360 Roll = 0,
361 Stop,
362 RecordEnable,
363 GotoStart,
364 GotoEnd,
365 AutoLoop,
366 PlaySelection,
367 ShuttleControl
371 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
372 void set_value (float);
373 float get_value (void) const;
375 void set_id (const std::string&);
377 ARDOUR_UI& ui;
378 ToggleType type;
381 boost::shared_ptr<TransportControllable> roll_controllable;
382 boost::shared_ptr<TransportControllable> stop_controllable;
383 boost::shared_ptr<TransportControllable> goto_start_controllable;
384 boost::shared_ptr<TransportControllable> goto_end_controllable;
385 boost::shared_ptr<TransportControllable> auto_loop_controllable;
386 boost::shared_ptr<TransportControllable> play_selection_controllable;
387 boost::shared_ptr<TransportControllable> rec_controllable;
388 boost::shared_ptr<TransportControllable> shuttle_controllable;
389 BindingProxy shuttle_controller_binding_proxy;
391 void set_transport_controllable_state (const XMLNode&);
392 XMLNode& get_transport_controllable_state ();
394 BindableButton roll_button;
395 BindableButton stop_button;
396 BindableButton goto_start_button;
397 BindableButton goto_end_button;
398 BindableButton auto_loop_button;
399 BindableButton play_selection_button;
400 BindableButton rec_button;
401 Gtk::ToggleButton join_play_range_button;
403 void toggle_external_sync ();
404 void toggle_time_master ();
405 void toggle_video_sync ();
407 Gtk::DrawingArea shuttle_box;
408 Gtk::EventBox speed_display_box;
409 Gtk::Label speed_display_label;
410 Gtk::Button shuttle_units_button;
411 Gtk::ComboBoxText shuttle_style_button;
412 Gtk::Menu* shuttle_unit_menu;
413 Gtk::Menu* shuttle_style_menu;
414 float shuttle_max_speed;
415 Gtk::Menu* shuttle_context_menu;
417 void build_shuttle_context_menu ();
418 void show_shuttle_context_menu ();
419 void shuttle_style_changed();
420 void shuttle_unit_clicked ();
421 void set_shuttle_max_speed (float);
422 void update_speed_display ();
423 float last_speed_displayed;
425 gint shuttle_box_button_press (GdkEventButton*);
426 gint shuttle_box_button_release (GdkEventButton*);
427 gint shuttle_box_scroll (GdkEventScroll*);
428 gint shuttle_box_motion (GdkEventMotion*);
429 gint shuttle_box_expose (GdkEventExpose*);
430 gint mouse_shuttle (double x, bool force);
431 void use_shuttle_fract (bool force);
433 bool shuttle_grabbed;
434 double shuttle_fract;
436 Gtkmm2ext::StatefulToggleButton punch_in_button;
437 Gtkmm2ext::StatefulToggleButton punch_out_button;
438 Gtkmm2ext::StatefulToggleButton auto_return_button;
439 Gtkmm2ext::StatefulToggleButton auto_play_button;
440 Gtkmm2ext::StatefulToggleButton auto_input_button;
441 Gtkmm2ext::StatefulToggleButton click_button;
442 Gtkmm2ext::StatefulToggleButton time_master_button;
443 Gtkmm2ext::StatefulToggleButton sync_button;
445 Gtk::ToggleButton auditioning_alert_button;
446 Gtk::ToggleButton solo_alert_button;
448 Gtk::VBox alert_box;
450 void solo_blink (bool);
451 void sync_blink (bool);
452 void audition_blink (bool);
454 void soloing_changed (bool);
455 void auditioning_changed (bool);
456 void _auditioning_changed (bool);
458 bool solo_alert_press (GdkEventButton* ev);
459 bool audition_alert_press (GdkEventButton* ev);
461 void big_clock_value_changed ();
462 void primary_clock_value_changed ();
463 void secondary_clock_value_changed ();
465 /* called by Blink signal */
467 void transport_rec_enable_blink (bool onoff);
469 Gtk::Menu* session_popup_menu;
471 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
472 RecentSessionModelColumns() {
473 add (visible_name);
474 add (fullpath);
476 Gtk::TreeModelColumn<Glib::ustring> visible_name;
477 Gtk::TreeModelColumn<Glib::ustring> fullpath;
480 RecentSessionModelColumns recent_session_columns;
481 Gtk::TreeView recent_session_display;
482 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
484 ArdourDialog* session_selector_window;
485 Gtk::FileChooserDialog* open_session_selector;
487 void build_session_selector();
488 void redisplay_recent_sessions();
489 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
491 struct RecentSessionsSorter {
492 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
493 return cmp_nocase(a.first, b.first) == -1;
497 /* menu bar and associated stuff */
499 Gtk::MenuBar* menu_bar;
500 Gtk::EventBox menu_bar_base;
501 Gtk::HBox menu_hbox;
503 void use_menubar_as_top_menubar ();
504 void build_menu_bar ();
506 Gtk::Label wall_clock_label;
507 Gtk::EventBox wall_clock_box;
508 gint update_wall_clock ();
510 Gtk::Label disk_space_label;
511 Gtk::EventBox disk_space_box;
512 void update_disk_space ();
514 Gtk::Label cpu_load_label;
515 Gtk::EventBox cpu_load_box;
516 void update_cpu_load ();
518 Gtk::Label buffer_load_label;
519 Gtk::EventBox buffer_load_box;
520 void update_buffer_load ();
522 Gtk::Label sample_rate_label;
523 Gtk::EventBox sample_rate_box;
524 void update_sample_rate (nframes_t);
526 gint every_second ();
527 gint every_point_one_seconds ();
528 gint every_point_zero_one_seconds ();
530 sigc::connection second_connection;
531 sigc::connection point_one_second_connection;
532 sigc::connection point_oh_five_second_connection;
533 sigc::connection point_zero_one_second_connection;
535 gint session_menu (GdkEventButton *);
537 bool _will_create_new_session_automatically;
539 void open_session ();
540 void open_recent_session ();
541 void save_template ();
543 void edit_metadata ();
544 void import_metadata ();
546 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);
547 void session_add_midi_route (bool disk, ARDOUR::RouteGroup *, uint32_t how_many);
549 void set_transport_sensitivity (bool);
551 void remove_last_capture ();
553 void transport_goto_zero ();
554 void transport_goto_start ();
555 void transport_goto_end ();
556 void transport_goto_wallclock ();
557 void transport_stop ();
558 void transport_stop_and_forget_capture ();
559 void transport_record (bool roll);
560 void transport_roll ();
561 void transport_play_selection();
562 void transport_forward (int option);
563 void transport_rewind (int option);
564 void transport_loop ();
565 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
567 bool _session_is_new;
568 void set_session (ARDOUR::Session *);
569 void connect_dependents_to_session (ARDOUR::Session *);
570 void we_have_dependents ();
572 void setup_session_options ();
574 guint32 last_key_press_time;
576 void snapshot_session ();
578 Mixer_UI *mixer;
579 int create_mixer ();
581 PublicEditor *editor;
582 int create_editor ();
584 RouteParams_UI *route_params;
585 int create_route_params ();
587 BundleManager *bundle_manager;
588 void create_bundle_manager ();
590 LocationUIWindow *location_ui;
591 int create_location_ui ();
592 void handle_locations_change (ARDOUR::Location*);
594 static UIConfiguration *ui_config;
595 ThemeManager *theme_manager;
597 /* Key bindings editor */
599 KeyEditor *key_editor;
601 /* RC Options window */
603 RCOptionEditor *rc_option_editor;
605 SessionOptionEditor *session_option_editor;
607 /* route dialog */
609 AddRouteDialog *add_route_dialog;
611 /* Keyboard Handling */
613 ArdourKeyboard* keyboard;
615 /* Keymap handling */
617 void install_actions ();
619 void toggle_record_enable (uint32_t);
621 uint32_t rec_enabled_streams;
622 void count_recenabled_streams (ARDOUR::Route&);
624 About* about;
625 Splash* splash;
626 void pop_back_splash ();
627 bool shown_flag;
629 /* cleanup */
631 Gtk::MenuItem *cleanup_item;
633 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
634 const std::string& plural_msg, const std::string& singular_msg);
635 void cleanup ();
636 void flush_trash ();
638 bool have_configure_timeout;
639 ARDOUR::microseconds_t last_configure_time;
640 gint configure_timeout ();
642 ARDOUR::microseconds_t last_peak_grab;
643 ARDOUR::microseconds_t last_shuttle_request;
645 struct DiskBufferStat {
646 time_t when;
647 uint32_t capture;
648 uint32_t playback;
650 DiskBufferStat (time_t w, uint32_t c, uint32_t p)
651 : when (w), capture (c), playback (p) {}
654 std::list<DiskBufferStat> disk_buffer_stats;
655 void push_buffer_stats (uint32_t, uint32_t);
656 void write_buffer_stats ();
658 bool have_disk_speed_dialog_displayed;
659 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
660 void disk_overrun_handler ();
661 void disk_underrun_handler ();
663 void session_dialog (std::string);
664 int pending_state_dialog ();
665 int sr_mismatch_dialog (nframes_t, nframes_t);
667 void disconnect_from_jack ();
668 void reconnect_to_jack ();
669 void set_jack_buffer_size (nframes_t);
671 Gtk::MenuItem* jack_disconnect_item;
672 Gtk::MenuItem* jack_reconnect_item;
673 Gtk::Menu* jack_bufsize_menu;
675 Glib::RefPtr<Gtk::ActionGroup> common_actions;
677 void editor_realized ();
679 std::vector<std::string> positional_sync_strings;
681 void toggle_send_midi_feedback ();
682 void toggle_use_mmc ();
683 void toggle_send_mmc ();
684 void toggle_send_mtc ();
685 void toggle_send_midi_clock ();
687 void toggle_use_osc ();
689 void parameter_changed (std::string);
691 bool first_idle ();
693 void no_memory_warning ();
694 void check_memory_locking ();
696 bool check_audioengine();
697 void audioengine_setup ();
699 void display_message (const char *prefix, gint prefix_len,
700 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
701 const char *msg);
702 Gtk::Label status_bar_label;
703 Gtk::ToggleButton error_log_button;
705 void loading_message (const std::string& msg);
706 void end_loading_messages ();
708 void platform_specific ();
709 void platform_setup ();
710 void fontconfig_dialog ();
712 PBD::ScopedConnectionList forever_connections;
715 #endif /* __ardour_gui_h__ */