source: examples/parse_args.h @ 7d7bf8f

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 7d7bf8f was 7d7bf8f, checked in by Paul Brossier <piem@piem.org>, 9 years ago

examples/parse_args.h: check in config.h if getopt.h was found
  • Property mode set to 100644
File size: 9.4 KB
Line 
1/*
2  Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
3
4  This file is part of aubio.
5
6  aubio is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10
11  aubio is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  GNU General Public License for more details.
15
16  You should have received a copy of the GNU General Public License
17  along with aubio.  If not, see <http://www.gnu.org/licenses/>.
18
19*/
20
21#include "config.h"
22
23#ifdef HAVE_GETOPT_H
24#include <getopt.h>
25#endif
26
27extern int verbose;
28// input / output
29extern int usejack;
30extern char_t *source_uri;
31extern char_t *sink_uri;
32// general stuff
33extern uint_t samplerate;
34extern uint_t buffer_size;
35extern uint_t hop_size;
36// onset stuff
37extern char_t * onset_method;
38extern smpl_t onset_threshold;
39// pitch stuff
40extern char_t * pitch_method;
41extern char_t * pitch_unit;
42extern smpl_t pitch_tolerance;
43// time stuff
44extern uint_t time_format;
45// tempo stuff
46extern char_t * tempo_method;
47// more general stuff
48extern smpl_t silence_threshold;
49extern uint_t mix_input;
50
51extern uint_t force_overwrite;
52
53// functions defined in utils.c
54extern void examples_common_init (int argc, char **argv);
55extern void examples_common_del (void);
56extern void examples_common_process (aubio_process_func_t process_func,
57    aubio_print_func_t print);
58int parse_args (int argc, char **argv);
59
60// internal stuff
61extern int blocks;
62
63extern fvec_t *ibuf;
64extern fvec_t *obuf;
65
66const char *prog_name;
67
68void usage (FILE * stream, int exit_code);
69
70void usage (FILE * stream, int exit_code)
71{
72#ifdef HAVE_GETOPT_H
73  fprintf (stream, "usage: %s [ options ] \n", prog_name);
74  fprintf (stream,
75      "       -i      --input            input file\n"
76#ifdef PROG_HAS_OUTPUT
77      "       -o      --output           output file\n"
78#endif
79      "       -r      --samplerate       select samplerate\n"
80      "                 use 0 to use input source samplerate, or 32000 to force 32kHz\n"
81      "       -B      --bufsize          set buffer size\n"
82      "                 number of frames to run the analysis on\n"
83      "       -H      --hopsize          set hopsize\n"
84      "                 number of frames to read from source before each analysis\n"
85#ifdef PROG_HAS_ONSET
86      "       -O      --onset            select onset detection algorithm\n"
87      "                 <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux>;\n"
88      "                 default=hfc\n"
89      "       -t      --onset-threshold  set onset detection threshold\n"
90      "                 a value between 0.1 (more detections) and 1 (less); default=0.3\n"
91#endif /* PROG_HAS_ONSET */
92#ifdef PROG_HAS_PITCH
93      "       -p      --pitch            select pitch detection algorithm\n"
94      "                 <default|yinfft|yin|mcomb|fcomb|schmitt>; default=yinfft\n"
95      "       -u      --pitch-unit       select pitch output unit\n"
96      "                 <default|freq|hertz|Hz|midi|cent|bin>; default=freq\n"
97      "       -l      --pitch-tolerance  select pitch tolerance\n"
98      "                 (yin, yinfft only) a value between 0.1 and 0.7; default=0.3\n"
99#endif /* PROG_HAS_PITCH */
100      "       -s      --silence          select silence threshold\n"
101      "                 a value in dB, for instance -70, or -100; default=-90\n"
102      "       -T      --time-format      select time values output format\n"
103      "                 (samples, ms, seconds) default=seconds\n"
104#ifdef PROG_HAS_OUTPUT
105      "       -m      --mix-input        mix input signal with output signal\n"
106      "                 input signal will be added to output synthesis\n"
107      "       -f      --force-overwrite  overwrite output file if needed\n"
108      "                 do not fail if output file already exists\n"
109#endif
110#ifdef PROG_HAS_JACK
111      "       -j      --jack             use Jack\n"
112#endif
113      "       -v      --verbose          be verbose\n"
114      "       -h      --help             display this message\n"
115      );
116#else /* HAVE_GETOPT_H */
117  fprintf (stream, "warning: compiled with getopt.h, no argument parsing\n");
118  fprintf (stream, "usage: %s <filename> \n", prog_name);
119#endif /* HAVE_GETOPT_H */
120  exit (exit_code);
121}
122
123int
124parse_args (int argc, char **argv)
125{
126#ifdef HAVE_GETOPT_H
127  const char *options = "hv"
128    "i:r:B:H:"
129#ifdef PROG_HAS_JACK
130    "j"
131#endif /* PROG_HAS_JACK */
132#ifdef PROG_HAS_OUTPUT
133    "o:"
134#endif /* PROG_HAS_OUTPUT */
135#ifdef PROG_HAS_ONSET
136    "O:t:"
137#endif /* PROG_HAS_ONSET */
138#ifdef PROG_HAS_PITCH
139    "p:u:l:"
140#endif /* PROG_HAS_PITCH */
141    "T:"
142    "s:mf";
143  int next_option;
144  struct option long_options[] = {
145    {"help",                  0, NULL, 'h'},
146    {"verbose",               0, NULL, 'v'},
147    {"input",                 1, NULL, 'i'},
148    {"samplerate",            1, NULL, 'r'},
149    {"bufsize",               1, NULL, 'B'},
150    {"hopsize",               1, NULL, 'H'},
151#ifdef PROG_HAS_JACK
152    {"jack",                  0, NULL, 'j'},
153#endif /* PROG_HAS_JACK */
154#ifdef PROG_HAS_OUTPUT
155    {"output",                1, NULL, 'o'},
156#endif /* PROG_HAS_OUTPUT */
157#ifdef PROG_HAS_ONSET
158    {"onset",                 1, NULL, 'O'},
159    {"onset-threshold",       1, NULL, 't'},
160#endif /* PROG_HAS_ONSET */
161#ifdef PROG_HAS_PITCH
162    {"pitch",                 1, NULL, 'p'},
163    {"pitch-unit",            1, NULL, 'u'},
164    {"pitch-tolerance",       1, NULL, 'l'},
165#endif /* PROG_HAS_PITCH */
166    {"silence",               1, NULL, 's'},
167    {"time-format",           1, NULL, 'T'},
168    {"mix-input",             0, NULL, 'm'},
169    {"force-overwrite",       0, NULL, 'f'},
170    {NULL,                    0, NULL, 0}
171  };
172#endif /* HAVE_GETOPT_H */
173  prog_name = argv[0];
174  if (argc < 1) {
175    usage (stderr, 1);
176    return -1;
177  }
178#ifdef HAVE_GETOPT_H
179  do {
180    next_option = getopt_long (argc, argv, options, long_options, NULL);
181    switch (next_option) {
182      case 'h':                /* help */
183        usage (stdout, 0);
184        return -1;
185      case 'v':                /* verbose */
186        verbose = 1;
187        break;
188      case 'j':
189        usejack = 1;
190        break;
191      case 'i':
192        source_uri = optarg;
193        break;
194      case 'o':
195        sink_uri = optarg;
196        break;
197      case 'f':                /* force_overwrite flag */
198        force_overwrite = 1;
199        break;
200      case 'r':
201        samplerate = atoi (optarg);
202        break;
203      case 'B':
204        buffer_size = atoi (optarg);
205        break;
206      case 'H':
207        hop_size = atoi (optarg);
208        break;
209      case 'O':                /*onset method */
210        onset_method = optarg;
211        break;
212      case 't':                /* threshold value for onset */
213        onset_threshold = (smpl_t) atof (optarg);
214        break;
215      case 'p':
216        pitch_method = optarg;
217        break;
218      case 'u':
219        pitch_unit = optarg;
220        break;
221      case 'l':
222        pitch_tolerance = (smpl_t) atof (optarg);
223        break;
224      case 'T':
225        if (strcmp (optarg, "samples") == 0) {
226          time_format = 2;
227        } else if (strcmp (optarg, "ms") == 0) {
228          time_format = 1;
229        } else if (strcmp (optarg, "seconds") == 0) {
230          time_format = 0;
231        } else {
232          errmsg ("Warning: did not get '%s' time-format string\n", optarg);
233        }
234        break;
235      case 's':                /* silence threshold */
236        silence_threshold = (smpl_t) atof (optarg);
237        break;
238      case 'm':                /* mix_input flag */
239        mix_input = 1;
240        break;
241      case '?':                /* unknown options */
242        usage (stderr, 1);
243        break;
244      case -1:                 /* done with options */
245        break;
246      default:                 /*something else unexpected */
247        fprintf (stderr, "Error parsing option '%c'\n", next_option);
248        abort ();
249    }
250  }
251  while (next_option != -1);
252#endif /* HAVE_GETOPT_H */
253
254  // if unique, use the non option argument as the source
255  if ( source_uri == NULL ) {
256    if (argc - optind == 1) {
257      source_uri = argv[optind];
258    } else if ( argc - optind > 1 ) {
259      errmsg ("Error: too many non-option arguments `%s'\n", argv[argc - 1]);
260      usage ( stderr, 1 );
261    }
262  } else if ( argc - optind > 0 ) {
263    errmsg ("Error: extra non-option argument %s\n", argv[optind]);
264    usage ( stderr, 1 );
265  }
266
267  // if no source, show a message
268  if (source_uri == NULL) {
269#ifdef PROG_HAS_JACK
270#if HAVE_JACK
271    verbmsg("No input source given, using jack\n");
272    usejack = 1;
273#else
274    errmsg("Error: no arguments given (and no available audio input)\n");
275    usage ( stderr, 1 );
276#endif /* HAVE_JACK */
277#else
278    errmsg("Error: no arguments given\n");
279    usage ( stderr, 1 );
280#endif /* PROG_HAS_JACK */
281  }
282
283  if ((sint_t)hop_size < 1) {
284    errmsg("Error: got hop_size %d, but can not be < 1\n", hop_size);
285    usage ( stderr, 1 );
286  } else if ((sint_t)buffer_size < 2) {
287    errmsg("Error: got buffer_size %d, but can not be < 2\n", buffer_size);
288    usage ( stderr, 1 );
289  } else if ((sint_t)buffer_size < (sint_t)hop_size) {
290    errmsg("Error: hop size (%d) is larger than win size (%d)\n",
291        hop_size, buffer_size);
292    usage ( stderr, 1 );
293  }
294
295  if ((sint_t)samplerate < 0) {
296    errmsg("Error: got samplerate %d, but can not be < 0\n", samplerate);
297    usage ( stderr, 1 );
298  }
299
300  return 0;
301}
Note: See TracBrowser for help on using the repository browser.