Merged with trunk R992.
[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 <ardour/ardour.h>
59 #include <ardour/session.h>
60
61 #include "audio_clock.h"
62 #include "ardour_dialog.h"
63 #include "editing.h"
64
65 class AudioClock;
66 class PublicEditor;
67 class Keyboard;
68 class MeterBridge;
69 class OptionEditor;
70 class Mixer_UI;
71 class ConnectionEditor;
72 class RouteParams_UI;
73 class SoundFileBrowser;
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(bool startup = false, 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_tempo_window ();
155         void toggle_editing_space();
156
157         Gtk::Tooltips& tooltips() { return _tooltips; }
158
159         static sigc::signal<void,bool> Blink;
160         static sigc::signal<void>      RapidScreenUpdate;
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         void choose_io (ARDOUR::IO&, bool input);
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 add_route ();
191         
192         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
193                 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
194         }
195
196         void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
197                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
198         }
199
200         void session_add_midi_track (uint32_t how_many) {
201                 session_add_midi_route (true, how_many);
202         }
203
204         /*void session_add_midi_bus () {
205                 session_add_midi_route (false);
206         }*/
207
208         void set_engine (ARDOUR::AudioEngine&);
209
210         gint exit_on_main_window_close (GdkEventAny *);
211
212         void maximise_editing_space ();
213         void restore_editing_space ();
214
215         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
216         void set_native_file_data_format (ARDOUR::SampleFormat sf);
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         void toggle_session_punch_in ();
231         
232         void toggle_options_window ();
233
234   private:
235         struct GlobalClickBox : public Gtk::VBox {
236             Gtkmm2ext::ClickBox  *box;
237             Gtk::Frame      frame;
238             Gtk::Label      label;
239             vector<string> &strings;
240             Gtk::Adjustment adjustment;
241
242             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
243
244             GlobalClickBox (const string &str, vector<string> &vs)
245                     : strings (vs),
246                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
247                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
248                     label.set_text (str);
249                     label.set_name ("GlobalButtonLabel");
250                     frame.add (*box);
251                     frame.set_shadow_type (Gtk::SHADOW_IN);
252                     pack_start (label);
253                     pack_start (frame);
254                     box->set_print_func (printer, this);
255                     box->set_wrap (true);
256             };
257         };
258
259         ARDOUR::AudioEngine                 *engine;
260         ARDOUR::Session                     *session;
261
262         Gtk::Tooltips          _tooltips;
263
264         void                     goto_editor_window ();
265         void                     goto_mixer_window ();
266         
267         Gtk::Table               adjuster_table;
268         Gtk::Frame               adjuster_frame;
269         Gtk::Fixed               adjuster_base;
270
271         GlobalClickBox     *online_control_button;
272         vector<string>      online_control_strings;
273
274         GlobalClickBox    *crossfade_time_button;
275         vector<string>     crossfade_time_strings;
276
277         GlobalClickBox    *mmc_id_button;
278         vector<string>     mmc_id_strings;
279
280         Gtk::ToggleButton   preroll_button;
281         Gtk::ToggleButton   postroll_button;
282
283         Gtk::Table          transport_table;
284         Gtk::Table          option_table;
285
286         int  setup_windows ();
287         void setup_session_menu ();
288         void setup_transport ();
289         void setup_clock ();
290         void setup_session_info ();
291         void setup_adjustables ();
292
293         Gtk::MenuBar* make_menubar ();
294         
295         static ARDOUR_UI *theArdourUI;
296
297         void startup ();
298         void shutdown ();
299
300         void finish();
301         int  ask_about_saving_session (const string & why);
302         gint ask_about_save_deleted (GdkEventAny*);
303         void save_session_choice_made (int);
304         int  save_the_session;
305
306         void queue_transport_change ();
307         void map_transport_state ();
308         int32_t do_engine_start ();
309         gint start_engine ();
310         
311         void engine_halted ();
312         void engine_stopped ();
313         void engine_running ();
314
315         void use_config ();
316
317         void clear_meters ();
318
319         static gint _blink  (void *);
320         void blink ();
321         gint blink_timeout_tag;
322         bool blink_on;
323         void start_blinking ();
324         void stop_blinking ();
325
326         void control_methods_adjusted ();
327         void mmc_device_id_adjusted ();
328
329   private:
330         Gtk::VBox     top_packer;
331
332         sigc::connection clock_signal_connection;
333         void         update_clocks ();
334         void         start_clocking ();
335         void         stop_clocking ();
336
337         void manage_window (Gtk::Window&);
338         
339         AudioClock   big_clock;
340         Gtk::Frame   big_clock_frame;
341         Gtk::Window* big_clock_window;
342
343         /* Transport Control */
344
345         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
346         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
347
348         Gtkmm2ext::TearOff*      transport_tearoff;
349         Gtk::Frame               transport_frame;
350         Gtk::HBox                transport_tearoff_hbox;
351         Gtk::HBox                transport_hbox;
352         Gtk::Fixed               transport_base;
353         Gtk::Fixed               transport_button_base;
354         Gtk::Frame               transport_button_frame;
355         Gtk::HBox                transport_button_hbox;
356         Gtk::VBox                transport_button_vbox;
357         Gtk::HBox                transport_option_button_hbox;
358         Gtk::VBox                transport_option_button_vbox;
359         Gtk::HBox                transport_clock_hbox;
360         Gtk::VBox                transport_clock_vbox;
361         Gtk::HBox                primary_clock_hbox;
362         Gtk::HBox                secondary_clock_hbox;
363
364         Gtkmm2ext::StatefulButton roll_button;
365         Gtkmm2ext::StatefulButton stop_button;
366         Gtkmm2ext::StatefulButton rewind_button;
367         Gtkmm2ext::StatefulButton forward_button;
368         Gtkmm2ext::StatefulButton goto_start_button;
369         Gtkmm2ext::StatefulButton goto_end_button;
370         Gtkmm2ext::StatefulButton auto_loop_button;
371         Gtkmm2ext::StatefulButton play_selection_button;
372
373         Gtkmm2ext::StatefulButton rec_button;
374
375         Gtk::ToggleButton time_master_button;
376         Gtk::ComboBoxText sync_option_combo;
377
378         void sync_option_changed ();
379         void toggle_time_master ();
380         void toggle_video_sync ();
381
382         Gtk::DrawingArea  shuttle_box;
383         Gtk::EventBox     speed_display_box;
384         Gtk::Label        speed_display_label;
385         Gtk::Button       shuttle_units_button;
386         Gtk::ComboBoxText shuttle_style_button;
387         Gtk::Menu*        shuttle_unit_menu;
388         Gtk::Menu*        shuttle_style_menu;
389         float             shuttle_max_speed;
390         Gtk::Menu*        shuttle_context_menu;
391
392         void build_shuttle_context_menu ();
393         void show_shuttle_context_menu ();
394         void shuttle_style_changed();
395         void shuttle_unit_clicked ();
396         void set_shuttle_max_speed (float);
397         void update_speed_display ();
398         float last_speed_displayed;
399
400         gint shuttle_box_button_press (GdkEventButton*);
401         gint shuttle_box_button_release (GdkEventButton*);
402         gint shuttle_box_scroll (GdkEventScroll*);
403         gint shuttle_box_motion (GdkEventMotion*);
404         gint shuttle_box_expose (GdkEventExpose*);
405         gint mouse_shuttle (double x, bool force);
406         void use_shuttle_fract (bool force);
407
408         bool   shuttle_grabbed;
409         double shuttle_fract;
410
411         Gtk::ToggleButton punch_in_button;
412         Gtk::ToggleButton punch_out_button;
413         Gtk::ToggleButton auto_return_button;
414         Gtk::ToggleButton auto_play_button;
415         Gtk::ToggleButton auto_input_button;
416         Gtk::ToggleButton click_button;
417         Gtk::ToggleButton auditioning_alert_button;
418         Gtk::ToggleButton solo_alert_button;
419
420         Gtk::VBox alert_box;
421
422         void solo_blink (bool);
423         void audition_blink (bool);
424
425         void soloing_changed (bool);
426         void auditioning_changed (bool);
427         void _auditioning_changed (bool);
428
429         void solo_alert_toggle ();
430         void audition_alert_toggle ();
431
432         void primary_clock_value_changed ();
433         void secondary_clock_value_changed ();
434
435         /* called by Blink signal */
436
437         void transport_rec_enable_blink (bool onoff);
438
439         /* These change where we accept control from:
440            MMC, X (local) or both.
441         */
442
443         void allow_mmc_only ();
444         void allow_mmc_and_local ();
445         void allow_local_only ();
446
447         static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
448
449         Gtk::Menu*        session_popup_menu;
450
451         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
452             RecentSessionModelColumns() { 
453                     add (visible_name);
454                     add (fullpath);
455             }
456             Gtk::TreeModelColumn<Glib::ustring> visible_name;
457             Gtk::TreeModelColumn<Glib::ustring> fullpath;
458         };
459
460         RecentSessionModelColumns    recent_session_columns;
461         Gtk::TreeView                recent_session_display;
462         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
463
464         ArdourDialog*     session_selector_window;
465         Gtk::FileChooserDialog* open_session_selector;
466         
467         void build_session_selector();
468         void recent_session_selection_changed ();
469         void redisplay_recent_sessions();
470         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
471
472         struct RecentSessionsSorter {
473             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
474                     return cmp_nocase(a.first, b.first) == -1;
475             }
476         };
477
478         /* menu bar and associated stuff */
479
480         Gtk::MenuBar* menu_bar;
481         Gtk::EventBox menu_bar_base;
482         Gtk::HBox     menu_hbox;
483
484         void build_menu_bar ();
485         void build_control_surface_menu ();
486         void pack_toplevel_controls();
487
488         Gtk::Label   wall_clock_label;
489         Gtk::EventBox wall_clock_box;
490         gint update_wall_clock ();
491
492         Gtk::Label   disk_space_label;
493         Gtk::EventBox disk_space_box;
494         void update_disk_space ();
495
496         Gtk::Label   cpu_load_label;
497         Gtk::EventBox cpu_load_box;
498         void update_cpu_load ();
499
500         Gtk::Label   buffer_load_label;
501         Gtk::EventBox buffer_load_box;
502         void update_buffer_load ();
503
504         Gtk::Label   sample_rate_label;
505         Gtk::EventBox sample_rate_box;
506         void update_sample_rate (nframes_t);
507
508         gint every_second ();
509         gint every_point_one_seconds ();
510         gint every_point_zero_one_seconds ();
511
512         sigc::connection second_connection;
513         sigc::connection point_one_second_connection;
514         sigc::connection point_zero_one_second_connection;
515
516         gint session_menu (GdkEventButton *);
517
518         bool _will_create_new_session_automatically;
519
520         NewSessionDialog* new_session_dialog;
521         
522         void open_session ();
523         void open_recent_session ();
524         void open_ok_clicked ();
525
526         void save_template ();
527
528         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
529         void session_add_midi_route (bool disk, uint32_t how_many);
530
531         void set_transport_sensitivity (bool);
532
533         void remove_last_capture ();
534
535         void transport_goto_zero ();
536         void transport_goto_start ();
537         void transport_goto_end ();
538         void transport_stop ();
539         void transport_stop_and_forget_capture ();
540         void transport_record ();
541         void transport_roll ();
542         void transport_play_selection(); 
543         void transport_forward (int option);
544         void transport_rewind (int option);
545         void transport_loop ();
546
547         void transport_locating ();
548         void transport_rolling ();
549         void transport_rewinding ();
550         void transport_forwarding ();
551         void transport_stopped ();
552
553         void send_all_midi_feedback ();
554         
555         bool _session_is_new;
556         void connect_to_session (ARDOUR::Session *);
557         void connect_dependents_to_session (ARDOUR::Session *);
558         void we_have_dependents ();
559         void setup_keybindings ();
560         void setup_session_options ();
561         
562         guint32  last_key_press_time;
563
564         void snapshot_session ();
565
566         void map_record_state ();
567         void queue_map_record_state ();
568
569         Mixer_UI   *mixer;
570         int         create_mixer ();
571         
572         PublicEditor     *editor;
573         int         create_editor ();
574
575         RouteParams_UI *route_params;
576         int             create_route_params ();
577
578         ConnectionEditor *connection_editor;
579         int               create_connection_editor ();
580
581         LocationUI *location_ui;
582         int         create_location_ui ();
583         void        handle_locations_change (ARDOUR::Location*);
584
585         ColorManager* color_manager;
586
587         /* Options window */
588         
589         OptionEditor *option_editor;
590         
591         /* route dialog */
592
593         AddRouteDialog *add_route_dialog;
594         void add_route_dialog_done (int status);
595
596         /* SoundFile Browser */
597         SoundFileBrowser *sfdb;
598         void toggle_sound_file_browser ();
599         int create_sound_file_browser ();
600         
601         /* Keyboard Handling */
602         
603         Keyboard* keyboard;
604
605         /* Keymap handling */
606
607         Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
608         void install_actions ();
609         void test_binding_action (const char *);
610         void start_keyboard_prefix();
611
612         void toggle_record_enable (uint32_t);
613
614         uint32_t rec_enabled_diskstreams;
615         void count_recenabled_diskstreams (ARDOUR::Route&);
616
617         About* about;
618         bool shown_flag;
619         /* cleanup */
620
621         Gtk::MenuItem *cleanup_item;
622
623         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
624         void cleanup ();
625         void flush_trash ();
626
627         bool have_configure_timeout;
628         struct timeval last_configure_time;
629         gint configure_timeout ();
630
631         struct timeval last_peak_grab;
632         struct timeval last_shuttle_request;
633
634         void editor_display_control_changed (Editing::DisplayControl c);
635
636         bool have_disk_overrun_displayed;
637         bool have_disk_underrun_displayed;
638
639         void disk_overrun_message_gone ();
640         void disk_underrun_message_gone ();
641         void disk_overrun_handler ();
642         void disk_underrun_handler ();
643
644         int pending_state_dialog ();
645         
646         void disconnect_from_jack ();
647         void reconnect_to_jack ();
648         void set_jack_buffer_size (nframes_t);
649
650         Gtk::MenuItem* jack_disconnect_item;
651         Gtk::MenuItem* jack_reconnect_item;
652         Gtk::Menu*     jack_bufsize_menu;
653
654         int make_session_clean ();
655         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
656
657         Glib::RefPtr<Gtk::ActionGroup> common_actions;
658
659         void editor_realized ();
660
661         std::vector<std::string> positional_sync_strings;
662
663         void toggle_send_midi_feedback ();
664         void toggle_use_mmc ();
665         void toggle_send_mmc ();
666         void toggle_use_midi_control();
667         void toggle_send_mtc ();
668
669         void set_input_auto_connect (ARDOUR::AutoConnectOption);
670         void set_output_auto_connect (ARDOUR::AutoConnectOption);
671         void set_solo_model (ARDOUR::SoloModel);
672         void set_monitor_model (ARDOUR::MonitorModel);
673
674         void toggle_StopPluginsWithTransport();
675         void toggle_DoNotRunPluginsWhileRecording();
676         void toggle_VerifyRemoveLastCapture();
677         void toggle_StopRecordingOnXrun();
678         void toggle_StopTransportAtEndOfSession();
679         void toggle_GainReduceFastTransport();
680         void toggle_LatchedSolo();
681         void toggle_SoloViaBus();
682         void toggle_LatchedRecordEnable ();
683
684         void mtc_port_changed ();
685         void map_solo_model ();
686         void map_monitor_model ();
687         void map_file_header_format ();
688         void map_file_data_format ();
689         void map_input_auto_connect ();
690         void map_output_auto_connect ();
691         void parameter_changed (const char*);
692
693         void set_meter_hold (ARDOUR::MeterHold);
694         void set_meter_falloff (ARDOUR::MeterFalloff);
695         void map_meter_hold ();
696         void map_meter_falloff ();
697
698         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
699         void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, const char* action_name);
700 };
701
702 #endif /* __ardour_gui_h__ */
703