new files for GTK-related platform specific stuff, where needed
[ardour.git] / gtk2_ardour / ardour_ui.h
1 /*
2     Copyright (C) 1999-2002 Paul Davis 
3
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.
8
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.
13
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.
17
18 */
19
20 #ifndef __ardour_gui_h__
21 #define __ardour_gui_h__
22
23 /* need _BSD_SOURCE to get timersub macros */
24
25 #ifdef _BSD_SOURCE
26 #include <sys/time.h>
27 #else
28 #define _BSD_SOURCE
29 #include <sys/time.h>
30 #undef _BSD_SOURCE
31 #endif
32
33 #include <list>
34
35 #include <cmath>
36
37 #include <libgnomecanvasmm/canvas.h>
38
39 #include <pbd/xml++.h>
40 #include <gtkmm/box.h>
41 #include <gtkmm/frame.h>
42 #include <gtkmm/label.h>
43 #include <gtkmm/table.h>
44 #include <gtkmm/fixed.h>
45 #include <gtkmm/drawingarea.h>
46 #include <gtkmm/eventbox.h>
47 #include <gtkmm/menu.h>
48 #include <gtkmm/menuitem.h>
49 #include <gtkmm/button.h>
50 #include <gtkmm/togglebutton.h>
51 #include <gtkmm/treeview.h>
52 #include <gtkmm/menubar.h>
53 #include <gtkmm/textbuffer.h>
54 #include <gtkmm/adjustment.h>
55 #include <gtkmm2ext/gtk_ui.h>
56 #include <gtkmm2ext/click_box.h>
57 #include <gtkmm2ext/stateful_button.h>
58 #include <gtkmm2ext/bindable_button.h>
59 #include <ardour/ardour.h>
60 #include <ardour/session.h>
61
62 #include "audio_clock.h"
63 #include "ardour_dialog.h"
64 #include "editing.h"
65 #include "ui_config.h"
66
67 class AudioClock;
68 class PublicEditor;
69 class Keyboard;
70 class OptionEditor;
71 class Mixer_UI;
72 class ConnectionEditor;
73 class RouteParams_UI;
74 class About;
75 class AddRouteDialog;
76 class LocationUI;
77 class ThemeManager;
78 class NewSessionDialog;
79
80 namespace Gtkmm2ext {
81         class TearOff;
82 }
83
84 namespace ARDOUR {
85         class AudioEngine;
86         class Route;
87         class Port;
88         class IO;
89         class ControlProtocolInfo;
90 }
91
92 namespace ALSA {
93         class MultiChannelDevice;
94 }
95
96 #define FRAME_NAME "BaseFrame"
97
98 extern sigc::signal<void>  ColorsChanged;
99
100 class ARDOUR_UI : public Gtkmm2ext::UI
101 {
102   public:
103         ARDOUR_UI (int *argcp, char **argvp[]);
104         ~ARDOUR_UI();
105
106         void show ();
107         bool shown() { return shown_flag; }
108         
109         void show_splash ();
110         void hide_splash ();
111         
112         int load_session (const string & path, const string & snapshot, string* mix_template = 0);
113         bool session_loaded;
114         int build_session (const string & path, const string & snapshot, 
115                            uint32_t ctl_chns, 
116                            uint32_t master_chns,
117                            ARDOUR::AutoConnectOption input_connect,
118                            ARDOUR::AutoConnectOption output_connect,
119                            uint32_t nphysin,
120                            uint32_t nphysout,
121                            nframes_t initial_length);
122         bool session_is_new() const { return _session_is_new; }
123
124         ARDOUR::Session* the_session() { return session; }
125
126         bool will_create_new_session_automatically() const {
127                 return _will_create_new_session_automatically;
128         }
129
130         void set_will_create_new_session_automatically (bool yn) {
131                 _will_create_new_session_automatically = yn;
132         }
133
134         bool get_session_parameters (Glib::ustring path, bool have_engine = false, bool should_be_new = false);
135         gint cmdline_new_session (string path);
136         int  unload_session (bool hide_stuff = false);
137         void close_session(); 
138
139         int  save_state_canfail (string state_name = "");
140         void save_state (const string & state_name = "");
141         void restore_state (string state_name = "");
142
143         static double gain_to_slider_position (ARDOUR::gain_t g);
144         static ARDOUR::gain_t slider_position_to_gain (double pos);
145
146         static ARDOUR_UI *instance () { return theArdourUI; }
147         static UIConfiguration *config () { return ui_config; }
148
149         PublicEditor&     the_editor(){return *editor;}
150         Mixer_UI* the_mixer() { return mixer; }
151         
152         void toggle_location_window ();
153         void toggle_theme_manager ();
154         void toggle_big_clock_window ();
155         void toggle_connection_editor ();
156         void toggle_route_params_window ();
157         void toggle_editing_space();
158
159         Gtk::Tooltips& tooltips() { return _tooltips; }
160
161         static sigc::signal<void,bool> Blink;
162         static sigc::signal<void>      RapidScreenUpdate;
163         static sigc::signal<void>      SuperRapidScreenUpdate;
164         static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
165
166         /* this is a helper function to centralize the (complex) logic for
167            blinking rec-enable buttons.
168         */
169
170         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
171
172         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
173
174         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
175
176         XMLNode* editor_settings() const;
177         XMLNode* mixer_settings () const;
178         XMLNode* keyboard_settings () const;
179
180         void save_ardour_state ();
181         gboolean configure_handler (GdkEventConfigure* conf);
182
183         void do_transport_locate (nframes_t position);
184         void halt_on_xrun_message ();
185
186         AudioClock primary_clock;
187         AudioClock secondary_clock;
188         AudioClock preroll_clock;
189         AudioClock postroll_clock;
190
191         void store_clock_modes ();
192         void restore_clock_modes ();
193
194         void add_route (Gtk::Window* float_window);
195         
196         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
197                 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
198         }
199
200         void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
201                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
202         }
203
204         void session_add_midi_track ();
205
206         int  create_engine ();
207         void post_engine ();
208
209         gint exit_on_main_window_close (GdkEventAny *);
210
211         void maximise_editing_space ();
212         void restore_editing_space ();
213
214         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
215         void set_native_file_data_format (ARDOUR::SampleFormat sf);
216
217         void set_keybindings_path (std::string path);
218         void save_keybindings ();
219
220         void setup_profile ();
221         void setup_theme ();
222
223         void set_shuttle_fract (double);
224
225   protected:
226         friend class PublicEditor;
227
228         void toggle_clocking ();
229         void toggle_auto_play ();
230         void toggle_auto_input ();
231         void toggle_punch_in ();
232         void toggle_punch_out ();
233         void toggle_auto_return ();
234         void toggle_click ();
235
236         void toggle_session_auto_loop ();
237         
238         void toggle_options_window ();
239
240   private:
241         struct GlobalClickBox : public Gtk::VBox {
242             Gtkmm2ext::ClickBox  *box;
243             Gtk::Frame      frame;
244             Gtk::Label      label;
245             vector<string> &strings;
246             Gtk::Adjustment adjustment;
247
248             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
249
250             GlobalClickBox (const string &str, vector<string> &vs)
251                     : strings (vs),
252                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
253                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
254                     label.set_text (str);
255                     label.set_name ("GlobalButtonLabel");
256                     frame.add (*box);
257                     frame.set_shadow_type (Gtk::SHADOW_IN);
258                     pack_start (label);
259                     pack_start (frame);
260                     box->set_print_func (printer, this);
261                     box->set_wrap (true);
262             };
263         };
264
265         ARDOUR::AudioEngine                 *engine;
266         ARDOUR::Session                     *session;
267
268         bool check_audioengine();
269
270         Gtk::Tooltips          _tooltips;
271
272         void                     goto_editor_window ();
273         void                     goto_mixer_window ();
274         
275         Gtk::Table               adjuster_table;
276         Gtk::Frame               adjuster_frame;
277         Gtk::Fixed               adjuster_base;
278
279         GlobalClickBox     *online_control_button;
280         vector<string>      online_control_strings;
281
282         GlobalClickBox    *crossfade_time_button;
283         vector<string>     crossfade_time_strings;
284
285         Gtk::ToggleButton   preroll_button;
286         Gtk::ToggleButton   postroll_button;
287
288         Gtk::Table          transport_table;
289         Gtk::Table          option_table;
290
291         int  setup_windows ();
292         void setup_transport ();
293         void setup_clock ();
294
295         static ARDOUR_UI *theArdourUI;
296
297         void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
298         void startup ();
299         void shutdown ();
300
301         void finish();
302         int  ask_about_saving_session (const string & why);
303         int  save_the_session;
304
305         /* periodic safety backup, to be precise */
306         gint autosave_session();
307         void update_autosave();
308         sigc::connection _autosave_connection;
309
310         void queue_transport_change ();
311         void map_transport_state ();
312         int32_t do_engine_start ();
313         
314         void engine_halted ();
315         void engine_stopped ();
316         void engine_running ();
317
318         void use_config ();
319
320         static gint _blink  (void *);
321         void blink ();
322         gint blink_timeout_tag;
323         bool blink_on;
324         void start_blinking ();
325         void stop_blinking ();
326
327         void about_signal_response(int response);
328
329
330   private:
331         Gtk::VBox     top_packer;
332
333         sigc::connection clock_signal_connection;
334         void         update_clocks ();
335         void         start_clocking ();
336         void         stop_clocking ();
337
338         void manage_window (Gtk::Window&);
339         
340         AudioClock   big_clock;
341         Gtk::Frame   big_clock_frame;
342         Gtk::Window* big_clock_window;
343
344         void update_transport_clocks (nframes_t pos);
345         void record_state_changed ();
346
347         /* Transport Control */
348
349         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
350         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
351
352         Gtkmm2ext::TearOff*      transport_tearoff;
353         Gtk::Frame               transport_frame;
354         Gtk::HBox                transport_tearoff_hbox;
355         Gtk::HBox                transport_hbox;
356         Gtk::Fixed               transport_base;
357         Gtk::Fixed               transport_button_base;
358         Gtk::Frame               transport_button_frame;
359         Gtk::HBox                transport_button_hbox;
360         Gtk::VBox                transport_button_vbox;
361         Gtk::HBox                transport_option_button_hbox;
362         Gtk::VBox                transport_option_button_vbox;
363         Gtk::HBox                transport_clock_hbox;
364         Gtk::VBox                transport_clock_vbox;
365         Gtk::HBox                primary_clock_hbox;
366         Gtk::HBox                secondary_clock_hbox;
367
368
369         struct TransportControllable : public PBD::Controllable {
370             enum ToggleType {
371                     Roll = 0,
372                     Stop,
373                     RecordEnable,
374                     GotoStart,
375                     GotoEnd,
376                     AutoLoop,
377                     PlaySelection,
378                     ShuttleControl
379                     
380             };
381             
382             TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
383             void set_value (float);
384             float get_value (void) const;
385             
386             void set_id (const std::string&);
387             
388             ARDOUR_UI& ui;
389             ToggleType type;
390         };
391
392         TransportControllable roll_controllable;
393         TransportControllable stop_controllable;
394         TransportControllable goto_start_controllable;
395         TransportControllable goto_end_controllable;
396         TransportControllable auto_loop_controllable;
397         TransportControllable play_selection_controllable;
398         TransportControllable rec_controllable;
399         TransportControllable shuttle_controllable;
400         BindingProxy shuttle_controller_binding_proxy;
401
402         void set_transport_controllable_state (const XMLNode&);
403         XMLNode& get_transport_controllable_state ();
404
405         BindableButton roll_button;
406         BindableButton stop_button;
407         BindableButton goto_start_button;
408         BindableButton goto_end_button;
409         BindableButton auto_loop_button;
410         BindableButton play_selection_button;
411         BindableButton rec_button;
412
413         Gtk::ComboBoxText sync_option_combo;
414
415         void sync_option_changed ();
416         void toggle_time_master ();
417         void toggle_video_sync ();
418
419         Gtk::DrawingArea  shuttle_box;
420         Gtk::EventBox     speed_display_box;
421         Gtk::Label        speed_display_label;
422         Gtk::Button       shuttle_units_button;
423         Gtk::ComboBoxText shuttle_style_button;
424         Gtk::Menu*        shuttle_unit_menu;
425         Gtk::Menu*        shuttle_style_menu;
426         float             shuttle_max_speed;
427         Gtk::Menu*        shuttle_context_menu;
428
429         void build_shuttle_context_menu ();
430         void show_shuttle_context_menu ();
431         void shuttle_style_changed();
432         void shuttle_unit_clicked ();
433         void set_shuttle_max_speed (float);
434         void update_speed_display ();
435         float last_speed_displayed;
436
437         gint shuttle_box_button_press (GdkEventButton*);
438         gint shuttle_box_button_release (GdkEventButton*);
439         gint shuttle_box_scroll (GdkEventScroll*);
440         gint shuttle_box_motion (GdkEventMotion*);
441         gint shuttle_box_expose (GdkEventExpose*);
442         gint mouse_shuttle (double x, bool force);
443         void use_shuttle_fract (bool force);
444
445         bool   shuttle_grabbed;
446         double shuttle_fract;
447
448         Gtkmm2ext::StatefulToggleButton punch_in_button;
449         Gtkmm2ext::StatefulToggleButton punch_out_button;
450         Gtkmm2ext::StatefulToggleButton auto_return_button;
451         Gtkmm2ext::StatefulToggleButton auto_play_button;
452         Gtkmm2ext::StatefulToggleButton auto_input_button;
453         Gtkmm2ext::StatefulToggleButton click_button;
454         Gtkmm2ext::StatefulToggleButton time_master_button;
455
456         Gtk::ToggleButton auditioning_alert_button;
457         Gtk::ToggleButton solo_alert_button;
458
459         Gtk::VBox alert_box;
460         
461         void solo_blink (bool);
462         void audition_blink (bool);
463
464         void soloing_changed (bool);
465         void auditioning_changed (bool);
466         void _auditioning_changed (bool);
467
468         void solo_alert_toggle ();
469         void audition_alert_toggle ();
470
471         void primary_clock_value_changed ();
472         void secondary_clock_value_changed ();
473
474         /* called by Blink signal */
475
476         void transport_rec_enable_blink (bool onoff);
477
478         Gtk::Menu*        session_popup_menu;
479
480         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
481             RecentSessionModelColumns() { 
482                     add (visible_name);
483                     add (fullpath);
484             }
485             Gtk::TreeModelColumn<Glib::ustring> visible_name;
486             Gtk::TreeModelColumn<Glib::ustring> fullpath;
487         };
488
489         RecentSessionModelColumns    recent_session_columns;
490         Gtk::TreeView                recent_session_display;
491         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
492
493         ArdourDialog*     session_selector_window;
494         Gtk::FileChooserDialog* open_session_selector;
495         
496         void build_session_selector();
497         void redisplay_recent_sessions();
498         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
499
500         struct RecentSessionsSorter {
501             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
502                     return cmp_nocase(a.first, b.first) == -1;
503             }
504         };
505
506         /* menu bar and associated stuff */
507
508         Gtk::MenuBar* menu_bar;
509         Gtk::EventBox menu_bar_base;
510         Gtk::HBox     menu_hbox;
511
512         void use_menubar_as_top_menubar ();
513
514         void build_menu_bar ();
515         void build_control_surface_menu ();
516
517         Gtk::Label   wall_clock_label;
518         Gtk::EventBox wall_clock_box;
519         gint update_wall_clock ();
520
521         Gtk::Label   disk_space_label;
522         Gtk::EventBox disk_space_box;
523         void update_disk_space ();
524
525         Gtk::Label   cpu_load_label;
526         Gtk::EventBox cpu_load_box;
527         void update_cpu_load ();
528
529         Gtk::Label   buffer_load_label;
530         Gtk::EventBox buffer_load_box;
531         void update_buffer_load ();
532
533         Gtk::Label   sample_rate_label;
534         Gtk::EventBox sample_rate_box;
535         void update_sample_rate (nframes_t);
536
537         gint every_second ();
538         gint every_point_one_seconds ();
539         gint every_point_zero_one_seconds ();
540
541         sigc::connection second_connection;
542         sigc::connection point_one_second_connection;
543         sigc::connection point_oh_five_second_connection;
544         sigc::connection point_zero_one_second_connection;
545
546         gint session_menu (GdkEventButton *);
547
548         bool _will_create_new_session_automatically;
549
550         NewSessionDialog* new_session_dialog;
551         
552         void open_session ();
553         void open_recent_session ();
554         void save_template ();
555
556         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
557
558         void set_transport_sensitivity (bool);
559
560         void remove_last_capture ();
561
562         void transport_goto_zero ();
563         void transport_goto_start ();
564         void transport_goto_end ();
565         void transport_stop ();
566         void transport_stop_and_forget_capture ();
567         void transport_record ();
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
574         void transport_rolling ();
575         void transport_rewinding ();
576         void transport_forwarding ();
577         void transport_stopped ();
578
579         bool _session_is_new;
580         void connect_to_session (ARDOUR::Session *);
581         void connect_dependents_to_session (ARDOUR::Session *);
582         void we_have_dependents ();
583         
584         std::string keybindings_path;
585         std::string user_keybindings_path;
586
587         void setup_keybindings ();
588         void setup_session_options ();
589         
590         guint32  last_key_press_time;
591
592         void snapshot_session ();
593
594         Mixer_UI   *mixer;
595         int         create_mixer ();
596         
597         PublicEditor     *editor;
598         int         create_editor ();
599
600         RouteParams_UI *route_params;
601         int             create_route_params ();
602
603         ConnectionEditor *connection_editor;
604         int               create_connection_editor ();
605
606         LocationUI *location_ui;
607         int         create_location_ui ();
608         void        handle_locations_change (ARDOUR::Location*);
609
610         static UIConfiguration *ui_config;
611         ThemeManager *theme_manager;
612
613         /* Options window */
614         
615         OptionEditor *option_editor;
616         
617         /* route dialog */
618
619         AddRouteDialog *add_route_dialog;
620         
621         /* Keyboard Handling */
622         
623         Keyboard* keyboard;
624
625         /* Keymap handling */
626
627         void install_actions ();
628
629         void toggle_record_enable (uint32_t);
630
631         uint32_t rec_enabled_streams;
632         void count_recenabled_streams (ARDOUR::Route&);
633
634         About* about;
635         bool shown_flag;
636         /* cleanup */
637
638         Gtk::MenuItem *cleanup_item;
639
640         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
641         void cleanup ();
642         void flush_trash ();
643
644         bool have_configure_timeout;
645         struct timeval last_configure_time;
646         gint configure_timeout ();
647
648         struct timeval last_peak_grab;
649         struct timeval last_shuttle_request;
650
651         bool have_disk_speed_dialog_displayed;
652         void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
653         void disk_overrun_handler ();
654         void disk_underrun_handler ();
655
656         int pending_state_dialog ();
657         
658         void disconnect_from_jack ();
659         void reconnect_to_jack ();
660         void set_jack_buffer_size (nframes_t);
661
662         Gtk::MenuItem* jack_disconnect_item;
663         Gtk::MenuItem* jack_reconnect_item;
664         Gtk::Menu*     jack_bufsize_menu;
665
666         int make_session_clean ();
667         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
668
669         Glib::RefPtr<Gtk::ActionGroup> common_actions;
670
671         void editor_realized ();
672
673         std::vector<std::string> positional_sync_strings;
674
675         void toggle_send_midi_feedback ();
676         void toggle_use_mmc ();
677         void toggle_send_mmc ();
678         void toggle_send_mtc ();
679
680         void toggle_use_osc ();
681
682         void toggle_denormal_protection ();
683
684         void set_input_auto_connect (ARDOUR::AutoConnectOption);
685         void set_output_auto_connect (ARDOUR::AutoConnectOption);
686         void set_solo_model (ARDOUR::SoloModel);
687         void set_monitor_model (ARDOUR::MonitorModel);
688         void set_remote_model (ARDOUR::RemoteModel);
689         void set_denormal_model (ARDOUR::DenormalModel);
690
691         void toggle_sync_order_keys ();
692         void toggle_StopPluginsWithTransport();
693         void toggle_DoNotRunPluginsWhileRecording();
694         void toggle_VerifyRemoveLastCapture();
695         void toggle_PeriodicSafetyBackups();
696         void toggle_StopRecordingOnXrun();
697         void toggle_StopTransportAtEndOfSession();
698         void toggle_GainReduceFastTransport();
699         void toggle_LatchedSolo();
700         void toggle_ShowSoloMutes();
701         void toggle_LatchedRecordEnable ();
702         void toggle_RegionEquivalentsOverlap ();
703         void toggle_PrimaryClockDeltaEditCursor ();
704         void toggle_SecondaryClockDeltaEditCursor ();
705         void toggle_only_copy_imported_files ();
706
707         void mtc_port_changed ();
708         void map_solo_model ();
709         void map_monitor_model ();
710         void map_denormal_model ();
711         void map_denormal_protection ();
712         void map_remote_model ();
713         void map_file_header_format ();
714         void map_file_data_format ();
715         void map_input_auto_connect ();
716         void map_output_auto_connect ();
717         void map_only_copy_imported_files ();
718         void parameter_changed (const char*);
719
720         void set_meter_hold (ARDOUR::MeterHold);
721         void set_meter_falloff (ARDOUR::MeterFalloff);
722         void map_meter_hold ();
723         void map_meter_falloff ();
724
725         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
726         void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
727
728         bool can_save_keybindings;
729         bool first_idle ();
730
731         void no_memory_warning ();
732         void check_memory_locking ();
733
734         void audioengine_setup ();
735
736         void display_message (const char *prefix, gint prefix_len, 
737                               Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
738         Gtk::Label status_bar_label;
739         Gtk::ToggleButton error_log_button;
740         Gtk::MessageDialog* loading_dialog;
741
742         void platform_specific ();
743 };
744
745 #endif /* __ardour_gui_h__ */
746