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         _vpu = new ComboOption<float> (
  64                 "video-pullup",
  65                 _("Pull-up / pull-down"),
  66                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_video_pullup),
  67                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_video_pullup)
  68                 );
  69
  70         _vpu->add (4.1667 + 0.1, _("4.1667 + 0.1%"));
  71         _vpu->add (4.1667, _("4.1667"));
  72         _vpu->add (4.1667 - 0.1, _("4.1667 - 0.1%"));
  73         _vpu->add (0.1, _("0.1"));
  74         _vpu->add (0, _("none"));
  75         _vpu->add (-0.1, _("-0.1"));
  76         _vpu->add (-4.1667 + 0.1, _("-4.1667 + 0.1%"));
  77         _vpu->add (-4.1667, _("-4.1667"));
  78         _vpu->add (-4.1667 - 0.1, _("-4.1667 - 0.1%"));
  79
  80         add_option (_("Timecode"), _vpu);
  81
  82         add_option (_("Sync"), new BoolOption (
  83                             "use-video-file-fps",
  84                             _("Use Video File's FPS Instead of Timecode Value for Timeline and Video Monitor."),
  85                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_use_video_file_fps),
  86                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_use_video_file_fps)
  87                             ));
  88
  89         add_option (_("Sync"), new BoolOption (
  90                             "videotimeline-pullup",
  91                             _("Apply Pull-Up/Down to Video Timeline and Video Monitor (Unless using JACK-sync)."),
  92                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_videotimeline_pullup),
  93                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_videotimeline_pullup)
  94                             ));
  95
  96         add_option (_("Timecode"), new OptionEditorHeading (_("Ext Timecode Offsets")));
  97
  98         ClockOption* sco = new ClockOption (
  99                 "slave-timecode-offset",
 100                 _("Slave Timecode offset"),
 101                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_slave_timecode_offset),
 102                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_slave_timecode_offset)
 103                 );
 104
 105         sco->set_session (_session);
 106         sco->clock().set_negative_allowed (true);
 107         Gtkmm2ext::UI::instance()->set_tip (sco->tip_widget(), _("The specified offset is added to the received timecode (MTC or LTC)."));
 108
 109         add_option (_("Timecode"), sco);
 110
 111         ClockOption* gco = new ClockOption (
 112                 "timecode-generator-offset",
 113                 _("Timecode Generator offset"),
 114                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_timecode_generator_offset),
 115                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_timecode_generator_offset)
 116                 );
 117
 118         gco->set_session (_session);
 119         gco->clock().set_negative_allowed (true);
 120         Gtkmm2ext::UI::instance()->set_tip (gco->tip_widget(), _("Specify an offset which is added to the generated timecode (so far only LTC)."));
 121
 122         add_option (_("Timecode"), gco);
 123
 124         add_option (_("Timecode"), new OptionEditorHeading (_("JACK Transport/Time Settings")));
 125
 126         add_option (_("Timecode"), new BoolOption (
 127                             "jack-time-master",
 128                             string_compose (_("%1 is JACK Time Master (provides Bar|Beat|Tick and other information to JACK)"), PROGRAM_NAME),
 129                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_jack_time_master),
 130                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_jack_time_master)
 131                             ));
 132
 133         /* FADES */
 134
 135         ComboOption<CrossfadeChoice>* cfc = new ComboOption<CrossfadeChoice> (
 136                 "xfade-choice",
 137                 _("Default crossfade type"),
 138                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_xfade_choice),
 139                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_xfade_choice)
 140                 );
 141
 142         cfc->add (ConstantPowerMinus3dB, _("Constant power (-3dB) crossfade"));
 143         cfc->add (ConstantPowerMinus6dB, _("Linear (-6dB) crossfade"));
 144
 145         add_option (_("Fades"), cfc);
 146
 147         add_option (_("Fades"), new SpinOption<float> (
 148                 _("destructive-xfade-seconds"),
 149                 _("Destructive crossfade length"),
 150                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_destructive_xfade_msecs),
 151                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_destructive_xfade_msecs),
 152                 0, 1000, 1, 10,
 153                 _("ms")
 154                             ));
 155
 156         add_option (_("Fades"), new BoolOption (
 157                             "use-region-fades",
 158                             _("Region fades active"),
 159                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_use_region_fades),
 160                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_use_region_fades)
 161                             ));
 162
 163         add_option (_("Fades"), new BoolOption (
 164                             "show-region-fades",
 165                             _("Region fades visible"),
 166                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_region_fades),
 167                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_region_fades)
 168                             ));
 169
 170         /* Media */
 171
 172         add_option (_("Media"), new OptionEditorHeading (_("Audio file format")));
 173
 174         ComboOption<SampleFormat>* sf = new ComboOption<SampleFormat> (
 175                 "native-file-data-format",
 176                 _("Sample format"),
 177                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_native_file_data_format),
 178                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_native_file_data_format)
 179                 );
 180
 181         sf->add (FormatFloat, _("32-bit floating point"));
 182         sf->add (FormatInt24, _("24-bit integer"));
 183         sf->add (FormatInt16, _("16-bit integer"));
 184
 185         add_option (_("Media"), sf);
 186
 187         ComboOption<HeaderFormat>* hf = new ComboOption<HeaderFormat> (
 188                 "native-file-header-format",
 189                 _("File type"),
 190                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_native_file_header_format),
 191                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_native_file_header_format)
 192                 );
 193
 194         hf->add (BWF, _("Broadcast WAVE"));
 195         hf->add (WAVE, _("WAVE"));
 196         hf->add (WAVE64, _("WAVE-64"));
 197         hf->add (CAF, _("CAF"));
 198
 199         add_option (_("Media"), hf);
 200
 201         add_option (_("Locations"), new OptionEditorHeading (_("File locations")));
 202
 203         SearchPathOption* spo = new SearchPathOption ("audio-search-path", _("Search for audio files in:"),
 204                                                       _session->path(),
 205                                                       sigc::mem_fun (*_session_config, &SessionConfiguration::get_audio_search_path),
 206                                                       sigc::mem_fun (*_session_config, &SessionConfiguration::set_audio_search_path));
 207         add_option (_("Locations"), spo);
 208
 209         spo = new SearchPathOption ("midi-search-path", _("Search for MIDI files in:"),
 210                                     _session->path(),
 211                                     sigc::mem_fun (*_session_config, &SessionConfiguration::get_midi_search_path),
 212                                     sigc::mem_fun (*_session_config, &SessionConfiguration::set_midi_search_path));
 213
 214         add_option (_("Locations"), spo);
 215
 216         /* File Naming  */
 217
 218         add_option (_("Filenames"), new OptionEditorHeading (_("File Naming")));
 219
 220         BoolOption *bo;
 221
 222         bo = new BoolOption (
 223                         "track-name-number",
 224                         _("Prefix Track number"),
 225                         sigc::mem_fun (*_session_config, &SessionConfiguration::get_track_name_number),
 226                         sigc::mem_fun (*_session_config, &SessionConfiguration::set_track_name_number)
 227                         );
 228         Gtkmm2ext::UI::instance()->set_tip (bo->tip_widget(),
 229                         _("Adds the current track number to the beginning of the recorded file name."));
 230         add_option (_("Filenames"), bo);
 231
 232         bo = new BoolOption (
 233                         "track-name-take",
 234                         _("Prefix Take Name"),
 235                         sigc::mem_fun (*_session_config, &SessionConfiguration::get_track_name_take),
 236                         sigc::mem_fun (*_session_config, &SessionConfiguration::set_track_name_take)
 237                         );
 238         Gtkmm2ext::UI::instance()->set_tip (bo->tip_widget(),
 239                         _("Adds the Take Name to the beginning of the recorded file name."));
 240         add_option (_("Filenames"), bo);
 241
 242         _take_name = new EntryOption (
 243                 "take-name",
 244                 _("Take Name"),
 245                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_take_name),
 246                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_take_name)
 247                 );
 248         _take_name->set_invalid_chars(".");
 249         _take_name->set_sensitive(_session_config->get_track_name_take());
 250
 251         add_option (_("Filenames"), _take_name);
 252
 253         /* Monitoring */
 254
 255         add_option (_("Monitoring"), new BoolOption (
 256                             "auto-input",
 257                             _("Track Input Monitoring automatically follows transport state (\"auto-input\")"),
 258                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_auto_input),
 259                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_auto_input)
 260                             ));
 261
 262         add_option (_("Monitoring"), new BoolOption (
 263                             "have-monitor-section",
 264                             _("Use monitor section in this session"),
 265                             sigc::mem_fun (*this, &SessionOptionEditor::get_use_monitor_section),
 266                             sigc::mem_fun (*this, &SessionOptionEditor::set_use_monitor_section)
 267                             ));
 268         /* Meterbridge */
 269         add_option (_("Meterbridge"), new OptionEditorHeading (_("Route Display")));
 270
 271         add_option (_("Meterbridge"), new BoolOption (
 272                             "show-midi-on-meterbridge",
 273                             _("Show Midi Tracks"),
 274                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_midi_on_meterbridge),
 275                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_midi_on_meterbridge)
 276                             ));
 277
 278         add_option (_("Meterbridge"), new BoolOption (
 279                             "show-busses-on-meterbridge",
 280                             _("Show Busses"),
 281                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_busses_on_meterbridge),
 282                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_busses_on_meterbridge)
 283                             ));
 284
 285         add_option (_("Meterbridge"), new BoolOption (
 286                             "show-master-on-meterbridge",
 287                             _("Include Master Bus"),
 288                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_master_on_meterbridge),
 289                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_master_on_meterbridge)
 290                             ));
 291
 292         add_option (_("Meterbridge"), new OptionEditorHeading (_("Button Area")));
 293
 294         add_option (_("Meterbridge"), new BoolOption (
 295                             "show-rec-on-meterbridge",
 296                             _("Rec-enable Button"),
 297                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_rec_on_meterbridge),
 298                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_rec_on_meterbridge)
 299                             ));
 300
 301         add_option (_("Meterbridge"), new BoolOption (
 302                             "show-mute-on-meterbridge",
 303                             _("Mute Button"),
 304                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_mute_on_meterbridge),
 305                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_mute_on_meterbridge)
 306                             ));
 307
 308         add_option (_("Meterbridge"), new BoolOption (
 309                             "show-solo-on-meterbridge",
 310                             _("Solo Button"),
 311                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_solo_on_meterbridge),
 312                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_solo_on_meterbridge)
 313                             ));
 314
 315         add_option (_("Meterbridge"), new BoolOption (
 316                             "show-monitor-on-meterbridge",
 317                             _("Monitor Buttons"),
 318                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_monitor_on_meterbridge),
 319                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_monitor_on_meterbridge)
 320                             ));
 321
 322         add_option (_("Meterbridge"), new OptionEditorHeading (_("Name Labels")));
 323
 324         add_option (_("Meterbridge"), new BoolOption (
 325                             "show-name-on-meterbridge",
 326                             _("Track Name"),
 327                             sigc::mem_fun (*_session_config, &SessionConfiguration::get_show_name_on_meterbridge),
 328                             sigc::mem_fun (*_session_config, &SessionConfiguration::set_show_name_on_meterbridge)
 329                             ));
 330
 331         /* Misc */
 332
 333         add_option (_("Misc"), new OptionEditorHeading (_("MIDI Options")));
 334
 335         add_option (_("Misc"), new BoolOption (
 336                                 "midi-copy-is-fork",
 337                                 _("MIDI region copies are independent"),
 338                                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_midi_copy_is_fork),
 339                                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_midi_copy_is_fork)
 340                                 ));
 341
 342         ComboOption<InsertMergePolicy>* li = new ComboOption<InsertMergePolicy> (
 343                         "insert-merge-policy",
 344                         _("Policy for handling overlapping notes\n on the same MIDI channel"),
 345                         sigc::mem_fun (*_session_config, &SessionConfiguration::get_insert_merge_policy),
 346                         sigc::mem_fun (*_session_config, &SessionConfiguration::set_insert_merge_policy)
 347                         );
 348
 349         li->add (InsertMergeReject, _("never allow them"));
 350         li->add (InsertMergeRelax, _("don't do anything in particular"));
 351         li->add (InsertMergeReplace, _("replace any overlapped existing note"));
 352         li->add (InsertMergeTruncateExisting, _("shorten the overlapped existing note"));
 353         li->add (InsertMergeTruncateAddition, _("shorten the overlapping new note"));
 354         li->add (InsertMergeExtend, _("replace both overlapping notes with a single note"));
 355
 356         add_option (_("Misc"), li);
 357
 358         add_option (_("Misc"), new OptionEditorHeading (_("Glue to bars and beats")));
 359
 360         add_option (_("Misc"), new BoolOption (
 361                                 "glue-new-markers-to-bars-and-beats",
 362                                 _("Glue new markers to bars and beats"),
 363                                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_glue_new_markers_to_bars_and_beats),
 364                                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_glue_new_markers_to_bars_and_beats)
 365                                 ));
 366
 367         add_option (_("Misc"), new BoolOption (
 368                                 "glue-new-regions-to-bars-and-beats",
 369                                 _("Glue new regions to bars and beats"),
 370                                 sigc::mem_fun (*_session_config, &SessionConfiguration::get_glue_new_regions_to_bars_and_beats),
 371                                 sigc::mem_fun (*_session_config, &SessionConfiguration::set_glue_new_regions_to_bars_and_beats)
 372                                 ));
 373
 374         add_option (_("Misc"), new OptionEditorHeading (_("Defaults")));
 375
 376         Gtk::Button* btn = Gtk::manage (new Gtk::Button (_("Use these settings as defaults")));
 377         btn->signal_clicked().connect (sigc::mem_fun (*this, &SessionOptionEditor::save_defaults));
 378         add_option (_("Misc"), new FooOption (btn));
 379
 380 }
 381
 382 void
 383 SessionOptionEditor::parameter_changed (std::string const & p)
 384 {
 385         OptionEditor::parameter_changed (p);
 386         if (p == "external-sync") {
 387                 if (Config->get_sync_source() == Engine) {
 388                         _vpu->set_sensitive(!_session_config->get_external_sync());
 389                 } else {
 390                         _vpu->set_sensitive(true);
 391                 }
 392         }
 393         else if (p == "timecode-format") {
 394                 /* update offset clocks */
 395                 parameter_changed("timecode-generator-offset");
 396                 parameter_changed("slave-timecode-offset");
 397         }
 398         else if (p == "track-name-take") {
 399                 _take_name->set_sensitive(_session_config->get_track_name_take());
 400         }
 401 }
 402
 403 /* the presence of absence of a monitor section is not really a regular session
 404  * property so we provide these two functions to act as setter/getter slots
 405  */
 406
 407 bool
 408 SessionOptionEditor::set_use_monitor_section (bool yn)
 409 {
 410         bool had_monitor_section = _session->monitor_out();
 411
 412         if (yn) {
 413                 _session->add_monitor_section ();
 414         } else {
 415                 _session->remove_monitor_section ();
 416         }
 417
 418         /* store this choice for any new sessions */
 419
 420         Config->set_use_monitor_bus (yn);
 421
 422         return had_monitor_section != yn;
 423 }
 424
 425 bool
 426 SessionOptionEditor::get_use_monitor_section ()
 427 {
 428         return _session->monitor_out() != 0;
 429 }
 430
 431 void
 432 SessionOptionEditor::save_defaults ()
 433 {
 434         _session->save_default_options();
 435 }