new SnapBBT debug option, split out BBT_time and start work on BBT arithmetic framewo...
[ardour.git] / gtk2_ardour / opts.cc
1 /*
2     Copyright (C) 2001 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 <getopt.h>
21 #include <string.h>
22 #include <iostream>
23 #include <cstdlib>
24
25 #include "ardour/debug.h"
26 #include "ardour/session.h"
27
28 #include "opts.h"
29
30 #include "i18n.h"
31
32 using namespace std;
33
34 string ARDOUR_COMMAND_LINE::session_name = "";
35 string ARDOUR_COMMAND_LINE::jack_client_name = "ardour";
36 bool  ARDOUR_COMMAND_LINE::show_key_actions = false;
37 bool ARDOUR_COMMAND_LINE::no_splash = true;
38 bool ARDOUR_COMMAND_LINE::just_version = false;
39 bool ARDOUR_COMMAND_LINE::use_vst = true;
40 bool ARDOUR_COMMAND_LINE::new_session = false;
41 char* ARDOUR_COMMAND_LINE::curvetest_file = 0;
42 bool ARDOUR_COMMAND_LINE::try_hw_optimization = true;
43 string ARDOUR_COMMAND_LINE::keybindings_path = ""; /* empty means use builtin default */
44 Glib::ustring ARDOUR_COMMAND_LINE::menus_file = "ardour.menus";
45 bool ARDOUR_COMMAND_LINE::finder_invoked_ardour = false;
46 string ARDOUR_COMMAND_LINE::immediate_save;
47
48 using namespace ARDOUR_COMMAND_LINE;
49
50 int
51 print_help (const char *execname)
52 {
53         cout << _("Usage: ") << execname << " [OPTION]... [SESSION_NAME]\n\n"
54              << _("  [SESSION_NAME]              Name of session to load\n")
55              << _("  -v, --version               Show version information\n")
56              << _("  -h, --help                  Print this message\n")
57              << _("  -b, --bindings              Print all possible keyboard binding names\n")
58              << _("  -c, --name <name>           Use a specific jack client name, default is ardour\n")
59              << _("  -d, --disable-plugins       Disable all plugins in an existing session\n")
60              << _("  -D, --debug <options>       Set debug flags. Use \"-D list\" to see available options\n")
61              << _("  -n, --show-splash           Show splash screen\n")
62              << _("  -m, --menus file            Use \"file\" for Ardour menus\n")
63              << _("  -N, --new session-name      Create a new session from the command line\n")
64              << _("  -O, --no-hw-optimizations   Disable h/w specific optimizations\n")
65              << _("  -S, --sync                  Draw the gui synchronously \n")
66 #ifdef VST_SUPPORT
67              << _("  -V, --novst                 Do not use VST support\n")
68 #endif
69              << _("  -E, --save <file>           Load the specified session, save it to <file> and then quit\n")
70              << _("  -C, --curvetest filename    Curve algorithm debugger\n")
71              << _("  -k, --keybindings filename  Name of key bindings to load (default is ~/.ardour3/ardour.bindings)\n")
72                 ;
73         return 1;
74
75 }
76
77 static void
78 list_debug_options ()
79 {
80         cerr << _("The following debug options are available. Separate multipe options with commas. Names are case-insensitive.") << "\n\n";
81         cerr << "\tMidiSourceIO\n";
82         cerr << "\tMidiPlaylistIO\n";
83         cerr << "\tMidiDiskstreamIO\n";
84         cerr << "\tSnapBBT\n";
85 }
86
87 static int
88 parse_debug_options (const char* str)
89 {
90         char* p;
91         char* sp;
92         uint64_t bits = 0;
93         char* copy = strdup (str);
94
95         p = strtok_r (copy, ",", &sp);
96
97         while (p) {
98                 if (strcasecmp (p, "list") == 0) {
99                         list_debug_options ();
100                         free (copy);
101                         return 1;
102                 }
103
104                 if (strcasecmp (p, "all") == 0) {
105                         ARDOUR::set_debug_bits (~0ULL);
106                         free (copy);
107                         return 0;
108                 }
109
110                 if (strcasecmp (p, "midisourceio") == 0) {
111                         bits |= ARDOUR::DEBUG::MidiSourceIO;
112                 } else if (strcasecmp (p, "midiplaylistio") == 0) {
113                         bits |= ARDOUR::DEBUG::MidiPlaylistIO;
114                 } else if (strcasecmp (p, "mididiskstreamio") == 0) {
115                         bits |= ARDOUR::DEBUG::MidiDiskstreamIO;
116                 } else if (strcasecmp (p, "snapbbt") == 0) {
117                         bits |= ARDOUR::DEBUG::SnapBBT;
118                 }
119
120                 p = strtok_r (0, ",", &sp);
121         }
122         
123         free (copy);
124         ARDOUR::set_debug_bits (bits);
125         return 0;
126 }
127
128
129 int
130 ARDOUR_COMMAND_LINE::parse_opts (int argc, char *argv[])
131 {
132         const char *optstring = "bc:C:dD:hk:E:m:N:nOp:SU:vV";
133         const char *execname = strrchr (argv[0], '/');
134
135         if (getenv ("ARDOUR_SAE")) {
136                 menus_file = "ardour-sae.menus";
137                 keybindings_path = "SAE";
138         }
139
140         if (execname == 0) {
141                 execname = argv[0];
142         } else {
143                 execname++;
144         }
145
146         const struct option longopts[] = {
147                 { "version", 0, 0, 'v' },
148                 { "help", 0, 0, 'h' },
149                 { "bindings", 0, 0, 'b' },
150                 { "debug", 1, 0, 'D' },
151                 { "show-splash", 0, 0, 'n' },
152                 { "menus", 1, 0, 'm' },
153                 { "name", 1, 0, 'c' },
154                 { "novst", 0, 0, 'V' },
155                 { "new", 1, 0, 'N' },
156                 { "no-hw-optimizations", 0, 0, 'O' },
157                 { "sync", 0, 0, 'S' },
158                 { "curvetest", 1, 0, 'C' },
159                 { "save", 1, 0, 'E' },
160                 { 0, 0, 0, 0 }
161         };
162
163         int option_index = 0;
164         int c = 0;
165
166         while (1) {
167                 c = getopt_long (argc, argv, optstring, longopts, &option_index);
168
169                 if (c == -1) {
170                         break;
171                 }
172
173                 switch (c) {
174                 case 0:
175                         break;
176
177                 case 'v':
178                         just_version = true;
179                         break;
180
181                 case 'h':
182                         print_help (execname);
183                         exit (0);
184                         break;
185                 case 'b':
186                         show_key_actions = true;
187                         break;
188
189                 case 'd':
190                         ARDOUR::Session::set_disable_all_loaded_plugins (true);
191                         break;
192
193                 case 'D':
194                         if (parse_debug_options (optarg)) {
195                                 exit (0);
196                         }
197                         break;
198                         
199                 case 'm':
200                         menus_file = optarg;
201                         break;
202
203                 case 'n':
204                         no_splash = false;
205                         break;
206
207                 case 'p':
208                         //undocumented OS X finder -psn_XXXXX argument
209                         finder_invoked_ardour = true;
210                         break;
211
212                 case 'S':
213                 //      ; just pass this through to gtk it will figure it out
214                         break;
215
216                 case 'N':
217                         new_session = true;
218                         session_name = optarg;
219                         break;
220
221                 case 'O':
222                         try_hw_optimization = false;
223                         break;
224
225                 case 'V':
226 #ifdef VST_SUPPORT
227                         use_vst = false;
228 #endif /* VST_SUPPORT */
229                         break;
230
231                 case 'c':
232                         jack_client_name = optarg;
233                         break;
234
235                 case 'C':
236                         curvetest_file = optarg;
237                         break;
238
239                 case 'k':
240                         keybindings_path = optarg;
241                         break;
242
243                 case 'E':
244                         immediate_save = optarg;
245                         break;
246
247                 default:
248                         return print_help(execname);
249                 }
250         }
251
252         if (optind < argc) {
253                 if (new_session) {
254                         cerr << "Illogical combination: you can either create a new session, or a load an existing session but not both!" << endl;
255                         return print_help(execname);
256                 }
257                 session_name = argv[optind++];
258         }
259
260         return 0;
261 }
262