aboutsummaryrefslogtreecommitdiffstats
path: root/arguments.hpp
blob: 8075236d4c81b88f674e22c769c981a42b35d9dd (plain) (blame)
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
/*
	gr-scan - A GNU Radio signal scanner
	Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.
	Copyright (C) 2012  Nicholas Tomlinson
	
	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 3 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, see <http://www.gnu.org/licenses/>.
*/

#include <stdlib.h>
#include <argp.h>
#include <string>

class Arguments
{
public:
	Arguments(int argc, char **argv) :
		avg_size(1000),
		bandwidth1(25000.0),
		bandwidth2(-1.0),
		spread(50000.0),
		threshold(3.0),
		centre_freq_1(87000000.0),
		centre_freq_2(108000000.0),
		sample_rate(2000000.0),
		fft_width(1000.0),
		step(-1.0),
		ptime(1.0)
	{
		argp_parse (&argp_i, argc, argv, 0, 0, this);
	}

	unsigned int get_avg_size()
	{
		return avg_size;
	}

	double get_bandwidth1()
	{
		return bandwidth1;
	}

	double get_bandwidth2()
	{
		if (bandwidth2 < 0.0)/* User did not specify a coarse band */
			return bandwidth1 * 8.0; /* I've found this to be a good choice for the coarse band */
		else
			return bandwidth2; /* If the user specified a bandwidth for this, use it */
	}

	double get_spread()
	{
		return spread;
	}

	double get_threshold()
	{
		return threshold;
	}

	double get_centre_freq_1()
	{
		return centre_freq_1;
	}

	double get_centre_freq_2()
	{
		return centre_freq_2;
	}

	double get_sample_rate()
	{
		return sample_rate;
	}

	double get_fft_width()
	{
		return fft_width;
	}

	double get_step()
	{
		if (step < 0.0)
			return sample_rate / 4.0; // I've found this to be a good choice (slightly faster might be / 3.0)
		else
			return step;
	}

	double get_time()
	{
		return ptime;
	}

	std::string get_outcsv()
	{
		return outcsv;
	}

private:
	static error_t s_parse_opt(int key, char *arg, struct argp_state *state)
	{
		Arguments *arguments = static_cast<Arguments *>(state->input);
		return arguments->parse_opt(key, arg, state);
	}

	error_t parse_opt(int key, char *arg, struct argp_state *state)
	{
		switch (key)
		{
		case 'a':
			avg_size = atoi(arg);
			break;
		case 'f':
			bandwidth1 = atof(arg) * 1000.0; //kHz
			break;
		case 'c':
			bandwidth2 = atof(arg) * 1000.0; //kHz
			break;
		case 's':
			spread = atof(arg) * 1000.0; //kHz
			break;
		case 't':
			threshold = atof(arg);
			break;
		case 'x':
			centre_freq_1 = atof(arg) * 1000000.0; //MHz
			break;
		case 'y':
			centre_freq_2 = atof(arg) * 1000000.0; //MHz
			break;
		case 'r':
			sample_rate = atof(arg) * 1000000.0; //MSamples/s
			break;
		case 'w':
			fft_width = atoi(arg);
			break;
		case 'z':
			step = atof(arg) * 1000000.0; //MHz
			break;
		case 'p':
			ptime = atof(arg);
			break;
		case 'o':
			outcsv = std::string(arg);
			break;
		case ARGP_KEY_ARG:
			if (state->arg_num > 0)
				argp_usage(state);
			break;
		case ARGP_KEY_END:
			break;
		default:
			return ARGP_ERR_UNKNOWN;
		}
		return 0;
	}

	static argp_option options[];
	static argp argp_i;

	unsigned int avg_size;
	double bandwidth1;
	double bandwidth2;
	double spread;
	double threshold;
	double centre_freq_1;
	double centre_freq_2;
	double sample_rate;
	double fft_width;
	double step;
	double ptime;
	std::string outcsv;
};

argp_option Arguments::options[] = {
	{"average", 'a', "COUNT", 0, "Average over COUNT samples (default: 1000)"},
	{"fine-bandwidth", 'f', "FREQ", 0, "Bandwidth of the fine window in kHz (default: 25)"},
	{"coarse-bandwidth", 'c', "FREQ", 0, "Bandwidth of the coarse window in kHz (default: fine-bandwidth * 8)"},
	{"spread", 's', "FREQ", 0, "Minimum frequency between detected signals in kHz (default: 50)"},
	{"threshold", 't', "POWER", 0, "Threshold for the difference between the coarse and fine filtered signals in dB (default: 3)"},
	{"start-frequency", 'x', "FREQ", 0, "Start frequency in MHz (default: 87)"},
	{"end-frequency", 'y', "FREQ", 0, "End frequency in MHz (default: 108)"},
	{"sample-rate", 'r', "RATE", 0, "Samplerate in Msamples/s (default: 2)"},
	{"fft-width", 'w', "COUNT", 0, "Width of FFT in samples (default: 1000)"},
	{"step", 'z', "FREQ", 0, "Increment step in MHz (default: sample-rate / 4)"},
	{"time", 'p', "TIME", 0, "Time in seconds to scan on each frequency (default: 1)"},
	{"output-csv", 'o', "OUTCSV", 0, "Output results to CSV file (default: [none])"},
	{0}
};

argp Arguments::argp_i = {options, s_parse_opt, 0, 0};

const char *argp_program_bug_address = "Jason@zx2c4.com";
const char *argp_program_version = 
		"gr-scan " VERSION " - A GNU Radio signal scanner\n"
				   "Copyright (C) 2015 Jason A. Donenfeld <Jason@zx2c4.com>. All Rights Reserved.\n"
				   "Copyright (C) 2012  Nicholas Tomlinson\n"
				   "\n"
				   "This program is free software: you can redistribute it and/or modify\n"
				   "it under the terms of the GNU General Public License as published by\n"
				   "the Free Software Foundation, either version 3 of the License, or\n"
				   "(at your option) any later version.\n"
				   "\n"
				   "This program is distributed in the hope that it will be useful,\n"
				   "but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
				   "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n"
				   "GNU General Public License for more details.\n"
				   "\n"
				   "You should have received a copy of the GNU General Public License\n"
				   "along with this program.  If not, see <http://www.gnu.org/licenses/>.";