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