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