summaryrefslogtreecommitdiff
path: root/gtk2_ardour/ardour_ui.h
blob: dc48856174ebc025b641593591db9e5b85151d2d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
/*
    Copyright (C) 1999-2002 Paul Davis 

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_gui_h__
#define __ardour_gui_h__

/* need _BSD_SOURCE to get timersub macros */

#ifdef _BSD_SOURCE
#include <sys/time.h>
#else
#define _BSD_SOURCE
#include <sys/time.h>
#undef _BSD_SOURCE
#endif

#include <list>

#include <cmath>

#include <libgnomecanvasmm/canvas.h>

#include <pbd/xml++.h>
#include <gtkmm/box.h>
#include <gtkmm/frame.h>
#include <gtkmm/label.h>
#include <gtkmm/table.h>
#include <gtkmm/fixed.h>
#include <gtkmm/drawingarea.h>
#include <gtkmm/eventbox.h>
#include <gtkmm/menu.h>
#include <gtkmm/menuitem.h>
#include <gtkmm/button.h>
#include <gtkmm/togglebutton.h>
#include <gtkmm/treeview.h>
#include <gtkmm/menubar.h>
#include <gtkmm/adjustment.h>
#include <gtkmm2ext/gtk_ui.h>
#include <gtkmm2ext/click_box.h>
#include <gtkmm2ext/stateful_button.h>
#include <gtkmm2ext/bindable_button.h>
#include <ardour/ardour.h>
#include <ardour/session.h>

#include "audio_clock.h"
#include "ardour_dialog.h"
#include "editing.h"

class AudioClock;
class PublicEditor;
class Keyboard;
class OptionEditor;
class Mixer_UI;
class ConnectionEditor;
class RouteParams_UI;
class About;
class AddRouteDialog;
class NewSessionDialog;
class LocationUI;
class ColorManager;

namespace Gtkmm2ext {
	class TearOff;
}

namespace ARDOUR {
	class AudioEngine;
	class Route;
	class Port;
	class IO;
	class ControlProtocolInfo;
}

namespace ALSA {
	class MultiChannelDevice;
}

#define FRAME_NAME "BaseFrame"

class ARDOUR_UI : public Gtkmm2ext::UI
{
  public:
	ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
	~ARDOUR_UI();

	void show ();
	bool shown() { return shown_flag; }
	
	void show_splash ();
	void hide_splash ();
	
	int load_session (const string & path, const string & snapshot, string* mix_template = 0);
	bool session_loaded;
	int build_session (const string & path, const string & snapshot, 
			   uint32_t ctl_chns, 
			   uint32_t master_chns,
			   ARDOUR::AutoConnectOption input_connect,
			   ARDOUR::AutoConnectOption output_connect,
			   uint32_t nphysin,
			   uint32_t nphysout,
			   nframes_t initial_length);
	bool session_is_new() const { return _session_is_new; }

	ARDOUR::Session* the_session() { return session; }

	bool will_create_new_session_automatically() const {
		return _will_create_new_session_automatically;
	}

	void set_will_create_new_session_automatically (bool yn) {
		_will_create_new_session_automatically = yn;
	}

        void new_session(std::string path = string());
	gint cmdline_new_session (string path);
	int  unload_session ();
	void close_session(); 

	int  save_state_canfail (string state_name = "");
	void save_state (const string & state_name = "");
	void restore_state (string state_name = "");

	static double gain_to_slider_position (ARDOUR::gain_t g);
        static ARDOUR::gain_t slider_position_to_gain (double pos);

	static ARDOUR_UI *instance () { return theArdourUI; }

	PublicEditor&	  the_editor(){return *editor;}
	Mixer_UI* the_mixer() { return mixer; }
	
	void toggle_location_window ();
	void toggle_color_manager ();
	void toggle_big_clock_window ();
	void toggle_connection_editor ();
	void toggle_route_params_window ();
	void toggle_editing_space();

	Gtk::Tooltips& tooltips() { return _tooltips; }

	static sigc::signal<void,bool> Blink;
	static sigc::signal<void>      RapidScreenUpdate;
	static sigc::signal<void>      MidRapidScreenUpdate;
	static sigc::signal<void>      SuperRapidScreenUpdate;
	static sigc::signal<void,nframes_t> Clock;

	/* this is a helper function to centralize the (complex) logic for
	   blinking rec-enable buttons.
	*/

	void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);

	void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);

	static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);

	XMLNode* editor_settings() const;
	XMLNode* mixer_settings () const;
	XMLNode* keyboard_settings () const;

	void save_ardour_state ();
	gboolean configure_handler (GdkEventConfigure* conf);

	void do_transport_locate (nframes_t position);
	void halt_on_xrun_message ();

	AudioClock primary_clock;
	AudioClock secondary_clock;
	AudioClock preroll_clock;
	AudioClock postroll_clock;

	void store_clock_modes ();
	void restore_clock_modes ();

	void add_route (Gtk::Window* float_window);
	
	void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
		session_add_audio_route (true, input_channels, output_channels, mode, how_many);
	}

	void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
		session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
	}

	void session_add_midi_track ();

	void set_engine (ARDOUR::AudioEngine&);
	gint start_engine ();

	gint exit_on_main_window_close (GdkEventAny *);

	void maximise_editing_space ();
	void restore_editing_space ();

	void set_native_file_header_format (ARDOUR::HeaderFormat sf);
	void set_native_file_data_format (ARDOUR::SampleFormat sf);

	void set_keybindings_path (std::string path);
	void save_keybindings ();

  protected:
	friend class PublicEditor;

	void toggle_clocking ();
	void toggle_auto_play ();
	void toggle_auto_input ();
	void toggle_punch_in ();
	void toggle_punch_out ();
	void toggle_auto_return ();
	void toggle_click ();

	void toggle_session_auto_loop ();
	
	void toggle_options_window ();

  private:
	struct GlobalClickBox : public Gtk::VBox {
	    Gtkmm2ext::ClickBox  *box;
	    Gtk::Frame      frame;
	    Gtk::Label      label;
	    vector<string> &strings;
	    Gtk::Adjustment adjustment;

	    static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);

	    GlobalClickBox (const string &str, vector<string> &vs)
		    : strings (vs),
		      adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
		    box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
		    label.set_text (str);
		    label.set_name ("GlobalButtonLabel");
		    frame.add (*box);
		    frame.set_shadow_type (Gtk::SHADOW_IN);
		    pack_start (label);
		    pack_start (frame);
		    box->set_print_func (printer, this);
		    box->set_wrap (true);
	    };
	};

	ARDOUR::AudioEngine                 *engine;
	ARDOUR::Session                     *session;

	Gtk::Tooltips          _tooltips;

	void                     goto_editor_window ();
	void                     goto_mixer_window ();
	
	Gtk::Table               adjuster_table;
	Gtk::Frame               adjuster_frame;
	Gtk::Fixed               adjuster_base;

	GlobalClickBox     *online_control_button;
	vector<string>      online_control_strings;

	GlobalClickBox    *crossfade_time_button;
	vector<string>     crossfade_time_strings;

	Gtk::ToggleButton   preroll_button;
	Gtk::ToggleButton   postroll_button;

	Gtk::Table          transport_table;
	Gtk::Table          option_table;

	int  setup_windows ();
	void setup_transport ();
	void setup_clock ();

	static ARDOUR_UI *theArdourUI;

	void startup ();
	void shutdown ();

	void finish();
	int  ask_about_saving_session (const string & why);
	int  save_the_session;

	void queue_transport_change ();
	void map_transport_state ();
	int32_t do_engine_start ();
	
	void engine_halted ();
	void engine_stopped ();
	void engine_running ();

	void use_config ();

	static gint _blink  (void *);
	void blink ();
	gint blink_timeout_tag;
	bool blink_on;
	void start_blinking ();
	void stop_blinking ();

	void about_signal_response(int response);

  private:
	Gtk::VBox     top_packer;

	sigc::connection clock_signal_connection;
	void         update_clocks ();
	void         start_clocking ();
	void         stop_clocking ();

	void manage_window (Gtk::Window&);
	
	AudioClock   big_clock;
	Gtk::Frame   big_clock_frame;
	Gtk::Window* big_clock_window;

	void update_transport_clocks (nframes_t pos);
	void record_state_changed ();

	/* Transport Control */

	void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
	void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);

	Gtkmm2ext::TearOff*      transport_tearoff;
	Gtk::Frame               transport_frame;
	Gtk::HBox                transport_tearoff_hbox;
	Gtk::HBox                transport_hbox;
	Gtk::Fixed               transport_base;
	Gtk::Fixed               transport_button_base;
	Gtk::Frame               transport_button_frame;
	Gtk::HBox                transport_button_hbox;
	Gtk::VBox                transport_button_vbox;
	Gtk::HBox                transport_option_button_hbox;
	Gtk::VBox                transport_option_button_vbox;
	Gtk::HBox                transport_clock_hbox;
	Gtk::VBox                transport_clock_vbox;
	Gtk::HBox                primary_clock_hbox;
	Gtk::HBox                secondary_clock_hbox;


	struct TransportControllable : public PBD::Controllable {
	    enum ToggleType {
		    Roll = 0,
		    Stop,
		    RecordEnable,
		    GotoStart,
		    GotoEnd,
		    AutoLoop,
		    PlaySelection,
		    ShuttleControl
		    
	    };
	    
	    TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
	    void set_value (float);
	    float get_value (void) const;
	    
	    void set_id (const std::string&);
	    
	    ARDOUR_UI& ui;
	    ToggleType type;
	};

	TransportControllable roll_controllable;
	TransportControllable stop_controllable;
	TransportControllable goto_start_controllable;
	TransportControllable goto_end_controllable;
	TransportControllable auto_loop_controllable;
	TransportControllable play_selection_controllable;
	TransportControllable rec_controllable;
	TransportControllable shuttle_controllable;
	BindingProxy shuttle_controller_binding_proxy;

	void set_transport_controllable_state (const XMLNode&);
	XMLNode& get_transport_controllable_state ();

	BindableButton roll_button;
	BindableButton stop_button;
	BindableButton goto_start_button;
	BindableButton goto_end_button;
	BindableButton auto_loop_button;
	BindableButton play_selection_button;
	BindableButton rec_button;

	Gtk::ComboBoxText sync_option_combo;

	void sync_option_changed ();
	void toggle_time_master ();
	void toggle_video_sync ();

	Gtk::DrawingArea  shuttle_box;
	Gtk::EventBox     speed_display_box;
	Gtk::Label        speed_display_label;
	Gtk::Button       shuttle_units_button;
	Gtk::ComboBoxText shuttle_style_button;
	Gtk::Menu*        shuttle_unit_menu;
	Gtk::Menu*        shuttle_style_menu;
	float             shuttle_max_speed;
	Gtk::Menu*        shuttle_context_menu;

	void build_shuttle_context_menu ();
	void show_shuttle_context_menu ();
	void shuttle_style_changed();
	void shuttle_unit_clicked ();
	void set_shuttle_max_speed (float);
	void update_speed_display ();
	float last_speed_displayed;

	gint shuttle_box_button_press (GdkEventButton*);
	gint shuttle_box_button_release (GdkEventButton*);
	gint shuttle_box_scroll (GdkEventScroll*);
	gint shuttle_box_motion (GdkEventMotion*);
	gint shuttle_box_expose (GdkEventExpose*);
	gint mouse_shuttle (double x, bool force);
	void use_shuttle_fract (bool force);
	void set_shuttle_fract (double);

	bool   shuttle_grabbed;
	double shuttle_fract;

	Gtkmm2ext::StatefulToggleButton punch_in_button;
	Gtkmm2ext::StatefulToggleButton punch_out_button;
	Gtkmm2ext::StatefulToggleButton auto_return_button;
	Gtkmm2ext::StatefulToggleButton auto_play_button;
	Gtkmm2ext::StatefulToggleButton auto_input_button;
	Gtkmm2ext::StatefulToggleButton click_button;
	Gtkmm2ext::StatefulToggleButton time_master_button;

	Gtk::ToggleButton auditioning_alert_button;
	Gtk::ToggleButton solo_alert_button;

	Gtk::VBox alert_box;
	
	void solo_blink (bool);
	void audition_blink (bool);

	void soloing_changed (bool);
	void auditioning_changed (bool);
	void _auditioning_changed (bool);

	void solo_alert_toggle ();
	void audition_alert_toggle ();

	void primary_clock_value_changed ();
	void secondary_clock_value_changed ();

	/* called by Blink signal */

	void transport_rec_enable_blink (bool onoff);

	Gtk::Menu*        session_popup_menu;

	struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
	    RecentSessionModelColumns() { 
		    add (visible_name);
		    add (fullpath);
	    }
	    Gtk::TreeModelColumn<Glib::ustring> visible_name;
	    Gtk::TreeModelColumn<Glib::ustring> fullpath;
	};

	RecentSessionModelColumns    recent_session_columns;
	Gtk::TreeView                recent_session_display;
	Glib::RefPtr<Gtk::TreeStore> recent_session_model;

	ArdourDialog*     session_selector_window;
	Gtk::FileChooserDialog* open_session_selector;
	
	void build_session_selector();
	void redisplay_recent_sessions();
	void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);

	struct RecentSessionsSorter {
	    bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
		    return cmp_nocase(a.first, b.first) == -1;
	    }
	};

	/* menu bar and associated stuff */

	Gtk::MenuBar* menu_bar;
	Gtk::EventBox menu_bar_base;
	Gtk::HBox     menu_hbox;

	void build_menu_bar ();
	void build_control_surface_menu ();

	Gtk::Label   wall_clock_label;
	Gtk::EventBox wall_clock_box;
	gint update_wall_clock ();

	Gtk::Label   disk_space_label;
	Gtk::EventBox disk_space_box;
	void update_disk_space ();

	Gtk::Label   cpu_load_label;
	Gtk::EventBox cpu_load_box;
	void update_cpu_load ();

	Gtk::Label   buffer_load_label;
	Gtk::EventBox buffer_load_box;
	void update_buffer_load ();

	Gtk::Label   sample_rate_label;
	Gtk::EventBox sample_rate_box;
	void update_sample_rate (nframes_t);

	gint every_second ();
	gint every_point_one_seconds ();
	gint every_point_oh_five_seconds ();
	gint every_point_zero_one_seconds ();

	sigc::connection second_connection;
	sigc::connection point_one_second_connection;
	sigc::connection point_oh_five_second_connection;
	sigc::connection point_zero_one_second_connection;

	gint session_menu (GdkEventButton *);

	bool _will_create_new_session_automatically;

	NewSessionDialog* new_session_dialog;
	
	void open_session ();
	void open_recent_session ();
	void save_template ();

	void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);

	void set_transport_sensitivity (bool);

	void remove_last_capture ();

	void transport_goto_zero ();
	void transport_goto_start ();
	void transport_goto_end ();
	void transport_stop ();
	void transport_stop_and_forget_capture ();
	void transport_record ();
	void transport_roll ();
	void transport_play_selection(); 
	void transport_forward (int option);
	void transport_rewind (int option);
	void transport_loop ();

	void transport_rolling ();
	void transport_rewinding ();
	void transport_forwarding ();
	void transport_stopped ();

	bool _session_is_new;
	void connect_to_session (ARDOUR::Session *);
	void connect_dependents_to_session (ARDOUR::Session *);
	void we_have_dependents ();
	
	std::string keybindings_path;

	void setup_keybindings ();
	void setup_session_options ();
	
	guint32  last_key_press_time;

	void snapshot_session ();

	Mixer_UI   *mixer;
	int         create_mixer ();
	
	PublicEditor     *editor;
	int         create_editor ();

	RouteParams_UI *route_params;
	int             create_route_params ();

	ConnectionEditor *connection_editor;
	int               create_connection_editor ();

	LocationUI *location_ui;
	int         create_location_ui ();
	void        handle_locations_change (ARDOUR::Location*);

	ColorManager* color_manager;

	/* Options window */
	
	OptionEditor *option_editor;
	
	/* route dialog */

	AddRouteDialog *add_route_dialog;
	
	/* Keyboard Handling */
	
	Keyboard* keyboard;

	/* Keymap handling */

	void install_actions ();

	void toggle_record_enable (uint32_t);

	uint32_t rec_enabled_streams;
	void count_recenabled_streams (ARDOUR::Route&);

	About* about;
	bool shown_flag;
	/* cleanup */

	Gtk::MenuItem *cleanup_item;

	void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
	void cleanup ();
	void flush_trash ();

	bool have_configure_timeout;
	struct timeval last_configure_time;
	gint configure_timeout ();

	struct timeval last_peak_grab;
	struct timeval last_shuttle_request;

	bool have_disk_speed_dialog_displayed;
	void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
	void disk_overrun_handler ();
	void disk_underrun_handler ();

	int pending_state_dialog ();
	
	void disconnect_from_jack ();
	void reconnect_to_jack ();
	void set_jack_buffer_size (nframes_t);

	Gtk::MenuItem* jack_disconnect_item;
	Gtk::MenuItem* jack_reconnect_item;
	Gtk::Menu*     jack_bufsize_menu;

	int make_session_clean ();
	bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);

	Glib::RefPtr<Gtk::ActionGroup> common_actions;

	void editor_realized ();

	std::vector<std::string> positional_sync_strings;

	void toggle_send_midi_feedback ();
	void toggle_use_mmc ();
	void toggle_send_mmc ();
	void toggle_use_midi_control();
	void toggle_send_mtc ();

	void toggle_use_osc ();

	void set_input_auto_connect (ARDOUR::AutoConnectOption);
	void set_output_auto_connect (ARDOUR::AutoConnectOption);
	void set_solo_model (ARDOUR::SoloModel);
	void set_monitor_model (ARDOUR::MonitorModel);
	void set_remote_model (ARDOUR::RemoteModel);

	void toggle_StopPluginsWithTransport();
	void toggle_DoNotRunPluginsWhileRecording();
	void toggle_VerifyRemoveLastCapture();
	void toggle_StopRecordingOnXrun();
	void toggle_StopTransportAtEndOfSession();
	void toggle_GainReduceFastTransport();
	void toggle_LatchedSolo();
	void toggle_ShowSoloMutes();
	void toggle_LatchedRecordEnable ();
	void toggle_RegionEquivalentsOverlap ();

	void mtc_port_changed ();
	void map_solo_model ();
	void map_monitor_model ();
	void map_remote_model ();
	void map_file_header_format ();
	void map_file_data_format ();
	void map_input_auto_connect ();
	void map_output_auto_connect ();
	void parameter_changed (const char*);

	void set_meter_hold (ARDOUR::MeterHold);
	void set_meter_falloff (ARDOUR::MeterFalloff);
	void map_meter_hold ();
	void map_meter_falloff ();

	void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
	void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);

	bool can_save_keybindings;
	bool first_idle ();

	void no_memory_warning ();
	void check_memory_locking ();
};

#endif /* __ardour_gui_h__ */