add tooltips to Offset config
[ardour.git] / gtk2_ardour / session_option_editor.cc
1 /*
2     Copyright (C) 2000-2010 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 #include "ardour/session.h"
21
22 #include "gui_thread.h"
23 #include "session_option_editor.h"
24 #include "search_path_option.h"
25 #include "i18n.h"
26
27 using namespace std;
28 using namespace ARDOUR;
29 using namespace Timecode;
30
31 SessionOptionEditor::SessionOptionEditor (Session* s)
32         : OptionEditor (&(s->config), _("Session Properties"))
33         , _session_config (&(s->config))
34 {
35         set_session (s);
36
37         set_name ("SessionProperties");
38
39         /* TIMECODE*/
40
41         add_option (_("Timecode"), new OptionEditorHeading (_("Timecode Settings")));
42
43         ComboOption<TimecodeFormat>* smf = new ComboOption<TimecodeFormat> (
44                 "timecode-format",
45                 _("Timecode frames-per-second"),
46                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_timecode_format),
47                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_timecode_format)
48                 );
49
50         smf->add (timecode_23976, _("23.976"));
51         smf->add (timecode_24, _("24"));
52         smf->add (timecode_24976, _("24.975"));
53         smf->add (timecode_25, _("25"));
54         smf->add (timecode_2997, _("29.97"));
55         smf->add (timecode_2997drop, _("29.97 drop"));
56         smf->add (timecode_30, _("30"));
57         smf->add (timecode_30drop, _("30 drop"));
58         smf->add (timecode_5994, _("59.94"));
59         smf->add (timecode_60, _("60"));
60
61         add_option (_("Timecode"), smf);
62
63         ComboOption<uint32_t>* spf = new ComboOption<uint32_t> (
64                 "subframes-per-frame",
65                 _("Subframes per frame"),
66                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_subframes_per_frame),
67                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_subframes_per_frame)
68                 );
69
70         spf->add (80, _("80"));
71         spf->add (100, _("100"));
72
73         add_option (_("Timecode"), spf);
74
75         _vpu = new ComboOption<float> (
76                 "video-pullup",
77                 _("Pull-up / pull-down"),
78                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_video_pullup),
79                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_video_pullup)
80                 );
81
82         _vpu->add (4.1667 + 0.1, _("4.1667 + 0.1%"));
83         _vpu->add (4.1667, _("4.1667"));
84         _vpu->add (4.1667 - 0.1, _("4.1667 - 0.1%"));
85         _vpu->add (0.1, _("0.1"));
86         _vpu->add (0, _("none"));
87         _vpu->add (-0.1, _("-0.1"));
88         _vpu->add (-4.1667 + 0.1, _("-4.1667 + 0.1%"));
89         _vpu->add (-4.1667, _("-4.1667"));
90         _vpu->add (-4.1667 - 0.1, _("-4.1667 - 0.1%"));
91
92         add_option (_("Timecode"), _vpu);
93
94
95         add_option (_("Timecode"), new OptionEditorHeading (_("Ext Timecode Offsets")));
96
97         ClockOption* sco = new ClockOption (
98                 "slave-timecode-offset",
99                 _("Slave Timecode offset"),
100                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_slave_timecode_offset),
101                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_slave_timecode_offset)
102                 );
103
104         sco->set_session (_session);
105         sco->clock().set_negative_allowed (true);
106         Gtkmm2ext::UI::instance()->set_tip (sco->tip_widget(), _("The specified offset is added to the received timecode (MTC or LTC)."));
107
108         add_option (_("Timecode"), sco);
109
110         ClockOption* gco = new ClockOption (
111                 "timecode-generator-offset",
112                 _("Timecode Generator offset"),
113                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_timecode_generator_offset),
114                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_timecode_generator_offset)
115                 );
116
117         gco->set_session (_session);
118         gco->clock().set_negative_allowed (true);
119         Gtkmm2ext::UI::instance()->set_tip (gco->tip_widget(), _("Specify an offset which is added to the generated timecode (so far only LTC)."));
120
121         add_option (_("Timecode"), gco);
122
123         add_option (_("Timecode"), new OptionEditorHeading (_("JACK Transport/Time Settings")));
124
125         add_option (_("Timecode"), new BoolOption (
126                             "jack-time-master",
127                             string_compose (_("%1 is JACK Time Master (provides Bar|Beat|Tick and other information to JACK)"), PROGRAM_NAME),
128                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_jack_time_master),
129                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_jack_time_master)
130                             ));
131
132         /* FADES */
133
134         ComboOption<CrossfadeModel>* cfm = new ComboOption<CrossfadeModel> (
135                 "xfade-model",
136                 _("Crossfades are created"),
137                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_xfade_model),
138                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_xfade_model)
139                 );
140
141         cfm->add (FullCrossfade, _("to span entire overlap"));
142         cfm->add (ShortCrossfade, _("short"));
143
144         add_option (_("Fades"), cfm);
145
146         ComboOption<CrossfadeChoice>* cfc = new ComboOption<CrossfadeChoice> (
147                 "xfade-choice",
148                 _("Crossfade type"),
149                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_xfade_choice),
150                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_xfade_choice)
151                 );
152
153         cfc->add (ConstantPowerMinus3dB, _("constant power (-3dB)"));
154         cfc->add (ConstantPowerMinus6dB, _("constant power (-6dB)"));
155         cfc->add (RegionFades, _("use existing region fade shape"));
156
157         add_option (_("Fades"), cfc);
158
159         add_option (_("Fades"), new SpinOption<float> (
160                 _("short-xfade-seconds"),
161                 _("Short crossfade length"),
162                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_short_xfade_seconds),
163                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_short_xfade_seconds),
164                 0, 1000, 1, 10,
165                 _("ms"), 0.001
166                             ));
167
168         add_option (_("Fades"), new SpinOption<float> (
169                 _("destructive-xfade-seconds"),
170                 _("Destructive crossfade length"),
171                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_destructive_xfade_msecs),
172                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_destructive_xfade_msecs),
173                 0, 1000, 1, 10,
174                 _("ms")
175                             ));
176
177         add_option (_("Fades"), new BoolOption (
178                             "auto-xfade",
179                             _("Create crossfades automatically"),
180                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_auto_xfade),
181                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_auto_xfade)
182                             ));
183
184         add_option (_("Fades"), new BoolOption (
185                             "use-region-fades",
186                             _("Region fades active"),
187                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_use_region_fades),
188                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_use_region_fades)
189                             ));
190
191         add_option (_("Fades"), new BoolOption (
192                             "show-region-fades",
193                             _("Region fades visible"),
194                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_region_fades),
195                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_region_fades)
196                             ));
197
198         /* Media */
199
200         add_option (_("Media"), new OptionEditorHeading (_("Audio file format")));
201
202         ComboOption<SampleFormat>* sf = new ComboOption<SampleFormat> (
203                 "native-file-data-format",
204                 _("Sample format"),
205                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_native_file_data_format),
206                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_native_file_data_format)
207                 );
208
209         sf->add (FormatFloat, _("32-bit floating point"));
210         sf->add (FormatInt24, _("24-bit integer"));
211         sf->add (FormatInt16, _("16-bit integer"));
212
213         add_option (_("Media"), sf);
214
215         ComboOption<HeaderFormat>* hf = new ComboOption<HeaderFormat> (
216                 "native-file-header-format",
217                 _("File type"),
218                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_native_file_header_format),
219                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_native_file_header_format)
220                 );
221
222         hf->add (BWF, _("Broadcast WAVE"));
223         hf->add (WAVE, _("WAVE"));
224         hf->add (WAVE64, _("WAVE-64"));
225         hf->add (CAF, _("CAF"));
226
227         add_option (_("Media"), hf);
228
229         add_option (_("Media"), new OptionEditorHeading (_("File locations")));
230
231         SearchPathOption* spo = new SearchPathOption ("audio-search-path", _("Search for audio files in:"),
232                                                       sigc::mem_fun (*_session_config, &SessionConfiguration::get_audio_search_path),
233                                                       sigc::mem_fun (*_session_config, &SessionConfiguration::set_audio_search_path));
234         add_option (_("Media"), spo);
235
236         spo = new SearchPathOption ("midi-search-path", _("Search for MIDI files in:"),
237                                     sigc::mem_fun (*_session_config, &SessionConfiguration::get_midi_search_path),
238                                     sigc::mem_fun (*_session_config, &SessionConfiguration::set_midi_search_path));
239
240         add_option (_("Media"), spo);
241
242         /* Monitoring */
243
244         add_option (_("Monitoring"), new BoolOption (
245                             "auto-input",
246                             _("Monitoring automatically follows transport state (\"auto-input\")"),
247                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_auto_input),
248                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_auto_input)
249                             ));
250
251         add_option (_("Monitoring"), new BoolOption (
252                             "have-monitor-section",
253                             _("Use monitor section in this session"),
254                             sigc::mem_fun (*this, &SessionOptionEditor::get_use_monitor_section),
255                             sigc::mem_fun (*this, &SessionOptionEditor::set_use_monitor_section)
256                             ));
257
258         /* Misc */
259
260         add_option (_("Misc"), new OptionEditorHeading (_("MIDI Options")));
261
262         add_option (_("Misc"), new BoolOption (
263                             "midi-copy-is-fork",
264                             _("MIDI region copies are independent"),
265                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_midi_copy_is_fork),
266                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_midi_copy_is_fork)
267                             ));
268
269         ComboOption<InsertMergePolicy>* li = new ComboOption<InsertMergePolicy> (
270                 "insert-merge-policy",
271                 _("Policy for handling overlapping notes\n on the same MIDI channel"),
272                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_insert_merge_policy),
273                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_insert_merge_policy)
274                 );
275
276         li->add (InsertMergeReject, _("never allow them"));
277         li->add (InsertMergeRelax, _("don't do anything in particular"));
278         li->add (InsertMergeReplace, _("replace any overlapped existing note"));
279         li->add (InsertMergeTruncateExisting, _("shorten the overlapped existing note"));
280         li->add (InsertMergeTruncateAddition, _("shorten the overlapping new note"));
281         li->add (InsertMergeExtend, _("replace both overlapping notes with a single note"));
282
283         add_option (_("Misc"), li);
284
285         add_option (_("Misc"), new OptionEditorHeading (_("Glue to bars and beats")));
286
287         add_option (_("Misc"), new BoolOption (
288                             "glue-new-markers-to-bars-and-beats",
289                             _("Glue new markers to bars and beats"),
290                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_glue_new_markers_to_bars_and_beats),
291                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_glue_new_markers_to_bars_and_beats)
292                             ));
293
294         add_option (_("Misc"), new BoolOption (
295                             "glue-new-regions-to-bars-and-beats",
296                             _("Glue new regions to bars and beats"),
297                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_glue_new_regions_to_bars_and_beats),
298                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_glue_new_regions_to_bars_and_beats)
299                             ));
300 }
301
302 void
303 SessionOptionEditor::parameter_changed (std::string const & p)
304 {
305         OptionEditor::parameter_changed (p);
306         if (p == "external-sync") {
307                 if (Config->get_sync_source() == JACK) {
308                         _vpu->set_sensitive(!_session_config->get_external_sync());
309                 } else {
310                         _vpu->set_sensitive(true);
311                 }
312         }
313         if (p == "timecode-format") {
314                 /* update offset clocks */
315                 parameter_changed("timecode-generator-offset");
316                 parameter_changed("slave-timecode-offset");
317         }
318 }
319
320 /* the presence of absence of a monitor section is not really a regular session
321  * property so we provide these two functions to act as setter/getter slots
322  */
323
324 bool
325 SessionOptionEditor::set_use_monitor_section (bool yn)
326 {
327         bool had_monitor_section = _session->monitor_out();
328
329         if (yn) {
330                 _session->add_monitor_section ();
331         } else {
332                 _session->remove_monitor_section ();
333         }
334
335         return had_monitor_section != yn;
336 }
337
338 bool
339 SessionOptionEditor::get_use_monitor_section ()
340 {
341         return _session->monitor_out() != 0;
342 }