-
Notifications
You must be signed in to change notification settings - Fork 1
/
RTLSDR.h
483 lines (429 loc) · 16.9 KB
/
RTLSDR.h
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
#pragma once
#include "CommonMacros.h"
SUPPRESS_WARNINGS_START
SUPPRESS_STL_WARNINGS
#include "SetThreadName.h"
#include <rtl-sdr.h>
#include <fstream>
#include <future>
SUPPRESS_WARNINGS_END
#include <cassert>
#include <condition_variable>
#include <cstddef>
#include <cstdint>
#include <filesystem>
#include <iostream>
#include <mutex>
#include <span>
#include <thread>
#include <unordered_set>
#include <vector>
#define M_PI 3.14159265358979323846
struct RTLSDR
{
using time_point = std::chrono::time_point<std::chrono::system_clock>;
struct IDataHandler
{
virtual ~IDataHandler() = default;
virtual void HandleData(std::span<uint8_t const> const& data) = 0;
};
static constexpr int AutoGain = -100;
static constexpr int MaxGain = 999999;
static constexpr int CorrectionPPM = 0;
static constexpr uint32_t SampleRate = 0; // Invalid
static constexpr size_t BufferLength = 32 * 512;
static constexpr size_t BufferCount = 16;
static constexpr uint32_t CenterFrequency = 0;
struct Config
{
int gain = MaxGain;
bool enableAGC = false;
uint32_t bufferLength = BufferLength;
uint32_t bufferCount = BufferCount;
uint32_t frequency = CenterFrequency;
uint32_t sampleRate = SampleRate;
};
struct DeviceInfo
{
uint32_t index;
char vendor[256];
char product[256];
char serial[256];
};
struct IDeviceSelector
{
virtual ~IDeviceSelector() = default;
virtual bool SelectDevice(DeviceInfo const& d) const = 0;
};
private:
struct _ManagerContext
{
_ManagerContext() = default;
~_ManagerContext() = default;
CLASS_DELETE_COPY_AND_MOVE(_ManagerContext);
std::atomic<bool> running{false};
rtlsdr_dev_t* dev{nullptr};
};
// RTLSDR is hugely single threaded
// Cannot open devices once a device is opened
// A manager is required for orchestration
struct _Manager
{
SUPPRESS_WARNINGS_START
SUPPRESS_CLANG_WARNING("-Wexit-time-destructors")
SUPPRESS_CLANG_WARNING("-Wglobal-constructors")
static inline std::mutex _mgr_mutex;
static inline std::weak_ptr<_Manager> _instance;
SUPPRESS_WARNINGS_END
static std::shared_ptr<_Manager> GetInstance()
{
std::lock_guard<std::mutex> lock_guard(_mgr_mutex);
if (_instance.expired())
{
auto ptr = std::make_shared<_Manager>();
_instance = ptr;
return ptr;
}
return _instance.lock();
}
_Manager() = default;
CLASS_DELETE_COPY_AND_MOVE(_Manager);
// Blocking call
void Start(RTLSDR* client)
{
SetThreadName("RTLSDR::ReadAsync");
{
std::unique_lock<std::mutex> guard(_mgr_mutex);
_clients.insert(client);
}
while (true)
{
SetThreadName("RTLSDR::ReadAsync");
rtlsdr_dev_t* dev = nullptr;
{
std::unique_lock<std::mutex> guard(_mgr_mutex);
if (_clients.count(client) == 0) return;
_RequestDevice(guard);
}
do {
{
std::unique_lock<std::mutex> guard(_mgr_mutex);
if (_clients.count(client) == 0) return;
dev = client->_mgrctx.dev;
}
if (dev == nullptr) { std::this_thread::sleep_for(std::chrono::milliseconds{500}); }
else { client->_mgrctx.running = true; }
} while (dev == nullptr);
rtlsdr_read_async(dev,
client->_Callback,
client,
client->_config.bufferCount,
client->_config.bufferCount * client->_config.bufferLength);
client->_mgrctx.running = false;
std::unique_lock<std::mutex> guard(_mgr_mutex);
if (client->_mgrctx.dev != nullptr && dev == client->_mgrctx.dev)
{
rtlsdr_close(dev);
client->_mgrctx.dev = nullptr;
}
}
}
void _Stop(std::unique_lock<std::mutex>& /*guard*/, RTLSDR* client)
{
auto dev = client->_mgrctx.dev;
if (dev != nullptr)
{
while (client->_mgrctx.running && rtlsdr_cancel_async(dev) != 0);
while (client->_mgrctx.running) std::this_thread::sleep_for(std::chrono::milliseconds{1});
rtlsdr_close(dev);
client->_mgrctx.dev = nullptr;
}
}
void Stop(RTLSDR* client)
{
std::unique_lock<std::mutex> guard(_mgr_mutex);
_Stop(guard, client);
_clients.erase(client);
}
void _RequestDevice(std::unique_lock<std::mutex> const& /*guard*/)
{
if (_clients.size() == 0) return;
if (_deviceSearching) return;
_deviceSearching = true;
_deviceSearchThread = std::async([this]() { this->_RequestDeviceImpl(); });
}
// Scenarios
// 1. Not enough devices.
// 2. Extra Devices
// 3. Disconnection
// 4. SpinDown
// 5. OnDeviceAvailable
void _RequestDeviceImpl()
{
SetThreadName("RTLSDR::ReqDev");
do {
try
{
// Let things stabilize a little
std::this_thread::sleep_for(std::chrono::milliseconds{100});
{
std::unique_lock<std::mutex> guard(_mgr_mutex);
_deviceSearching = false;
if (_clients.size() == 0) { return; }
for (auto client : _clients) { _Stop(guard, client); }
}
auto deviceCountLambda = [&]() {
std::unique_lock<std::mutex> guard(_mgr_mutex);
return rtlsdr_get_device_count();
};
auto deviceCount = deviceCountLambda();
while (deviceCount == 0)
{
std::this_thread::sleep_for(std::chrono::milliseconds{500});
deviceCount = deviceCountLambda();
}
{
std::unique_lock<std::mutex> guard(_mgr_mutex);
// Sometimes only one device shows up. Wait a bit and retry
std::this_thread::sleep_for(std::chrono::milliseconds{500});
deviceCount = rtlsdr_get_device_count();
if (deviceCount == 0) continue;
for (uint32_t i = 0; i < deviceCount; i++)
{
DeviceInfo d;
d.index = i;
rtlsdr_get_device_usb_strings(d.index, d.vendor, d.product, d.serial);
rtlsdr_dev_t* dev;
if (rtlsdr_open(&dev, d.index) != 0)
{
// logging
continue;
}
for (auto& client : _clients)
{
if (client->_mgrctx.dev) continue; // from an earlier outer for loop
if ((client->_deviceIndex != InvalidDeviceIndex && d.index == client->_deviceIndex)
|| (client->_selector && client->_selector->SelectDevice(d)))
{
_OpenDevice(dev, client->_config);
client->_mgrctx.dev = dev;
dev = nullptr;
break;
}
}
if (dev != nullptr)
{
// Couldnt match a selector. Just assign to the first client that needs a device
for (auto& client : _clients)
{
if (client->_mgrctx.dev) continue; // from an earlier outer for loop
_OpenDevice(dev, client->_config);
client->_mgrctx.dev = dev;
dev = nullptr;
break;
}
}
if (dev != nullptr)
{
// Couldnt find any client needing a device. Ignore and move on
rtlsdr_close(dev);
}
}
}
break;
} catch (std::exception const&)
{
_deviceSearching = true;
}
} while (true);
}
void _OpenDevice(rtlsdr_dev_t* dev, RTLSDR::Config const& config)
{
auto gain = config.gain;
/* Set gain, frequency, sample rate, and reset the device. */
rtlsdr_set_tuner_gain_mode(dev, (gain == AutoGain) ? 0 : 1);
if (gain != AutoGain)
{
if (gain == MaxGain)
{
/* Find the maximum gain available. */
int gains[100];
int numgains = rtlsdr_get_tuner_gains(dev, gains);
gain = gains[numgains - 1];
}
rtlsdr_set_tuner_gain(dev, gain);
}
rtlsdr_set_freq_correction(dev, CorrectionPPM);
rtlsdr_set_agc_mode(dev, config.enableAGC);
rtlsdr_set_center_freq(dev, config.frequency);
rtlsdr_set_sample_rate(dev, config.sampleRate);
rtlsdr_reset_buffer(dev);
//_currentGain = rtlsdr_get_tuner_gain(dev) / 10;
}
bool _deviceSearching{false};
std::future<void> _deviceSearchThread;
std::unordered_set<RTLSDR*> _clients;
};
public:
static constexpr uint32_t InvalidDeviceIndex = std::numeric_limits<uint32_t>::max();
RTLSDR(IDeviceSelector const* const selector, uint32_t deviceIndex, Config const& config) :
_selector(selector), _deviceIndex(deviceIndex), _config(config)
{
_sizeMask = _config.bufferCount - 1;
if ((_config.bufferCount & _sizeMask) != 0) { throw std::logic_error("Buffer Count requested is not a power of 2"); }
_cyclicBuffer.resize(_config.bufferCount);
_testDataFile = std::filesystem::absolute(std::to_string(config.frequency) + ".test.dat");
if (std::filesystem::exists(_testDataFile))
{
_useTestDataFile = true;
return;
}
if (_deviceIndex != InvalidDeviceIndex)
{
//_OpenDevice(_deviceIndex);
}
else if (_selector == nullptr) { throw std::invalid_argument("Either a device index or a selector required"); }
}
RTLSDR(uint32_t deviceIndex, Config const& config) : RTLSDR(nullptr, deviceIndex, config) {}
RTLSDR(IDeviceSelector const* const selector, Config const& config) : RTLSDR(selector, InvalidDeviceIndex, config) {}
CLASS_DELETE_COPY_AND_MOVE(RTLSDR);
void _TestDataReadLoop()
{
std::vector<std::vector<uint8_t>> buffers;
for (size_t i = 0; i < _config.bufferCount; i++) { buffers.push_back(std::vector<uint8_t>(_config.bufferLength)); }
_testDataIFS = std::ifstream(_testDataFile.string(), std::ios::binary | std::ios::in);
if (!_testDataIFS.good()) { throw std::runtime_error("Cannot open test data file"); }
size_t bufferToUse = 0;
while (!_stopRequested)
{
_testDataIFS.read(reinterpret_cast<char*>(buffers[bufferToUse].data()), static_cast<std::streamsize>(_config.bufferLength));
if (!_testDataIFS.good())
{
_testDataIFS.close();
_testDataIFS = std::ifstream(_testDataFile.string(), std::ios::binary | std::ios::in);
if (!_testDataIFS.good()) { throw std::runtime_error("Cannot open test data file"); }
continue;
}
_OnDataAvailable(buffers[bufferToUse]);
bufferToUse = (bufferToUse + 1) % _config.bufferCount;
}
_testDataIFS.close();
}
void Start(IDataHandler* handler)
{
Stop();
_stopRequested = false;
_handler = handler;
if (_producerThrd.joinable()) _producerThrd.join();
if (_consumerThrd.joinable()) _consumerThrd.join();
if (_useTestDataFile)
{
_producerThrd = std::thread([this]() {
SetThreadName("RTLSDR-TestDataFile-Reader");
_TestDataReadLoop();
});
}
else
{
_producerThrd = std::thread([this]() {
SetThreadName("RTLSDR::ReadAsync");
_device_manager->Start(this);
});
}
_consumerThrd = std::thread([this]() {
SetThreadName("RTLSDR::DataHandler");
this->_ConsumerThreadLoop();
});
}
void Stop()
{
_stopRequested = true;
_device_manager->Stop(this);
_cvDataConsumed.notify_all();
_cvDataAvailable.notify_all();
// Joining can cause hangs on repeat start and stop if the data thread is waiting on mutex
// if (_producerThrd.joinable()) _producerThrd.join();
// if (_consumerThrd.joinable()) _consumerThrd.join();
}
bool _HasSlot(std::unique_lock<std::mutex> const& /*lock*/) const { return ((_tail + 1) & _sizeMask) != _head; }
bool _IsEmpty(std::unique_lock<std::mutex> const& /*lock*/) const { return _head == _tail; }
void _OnDataAvailable(std::span<uint8_t const> const& data)
{
std::unique_lock lock(_mutex);
if (!_HasSlot(lock))
{
_cvDataConsumed.wait(lock, [&, this]() { return _HasSlot(lock) || _stopRequested; });
if (_stopRequested) return;
}
_cyclicBuffer[_tail] = {time_point::clock::now(), data};
_tail = (_tail + 1) & _sizeMask;
_cvDataAvailable.notify_one();
}
auto& _GetAtHead()
{
std::unique_lock lock(_mutex);
return _cyclicBuffer[_head];
}
void _ConsumerThreadLoop()
{
while (!_stopRequested)
{
{
std::unique_lock lock(_mutex);
if (_IsEmpty(lock))
{
_cvDataAvailable.wait(lock, [&, this]() { return !_IsEmpty(lock) || _stopRequested; });
continue;
}
}
if (_stopRequested) break;
_handler->HandleData(_GetAtHead().data);
{
std::unique_lock lock(_mutex);
_head = (_head + 1) & _sizeMask;
_cvDataConsumed.notify_one();
}
}
}
~RTLSDR()
{
Stop();
if (_producerThrd.joinable()) _producerThrd.join();
if (_consumerThrd.joinable()) _consumerThrd.join();
}
private:
static void _Callback(uint8_t* buf, uint32_t len, void* ctx) noexcept
{
try
{
reinterpret_cast<RTLSDR*>(ctx)->_OnDataAvailable({buf, len});
} catch (std::exception const& ex)
{
std::cerr << ex.what() << std::endl;
}
}
std::shared_ptr<_Manager> _device_manager = _Manager::GetInstance();
_ManagerContext _mgrctx;
IDeviceSelector const* const _selector{};
uint32_t _deviceIndex{InvalidDeviceIndex};
Config _config{};
struct Entry
{
time_point time;
std::span<uint8_t const> data;
};
std::vector<Entry> _cyclicBuffer;
size_t _sizeMask{0};
size_t _head{0};
size_t _tail{0};
IDataHandler* _handler;
std::thread _producerThrd;
std::thread _consumerThrd;
std::mutex _mutex;
std::condition_variable _cvDataAvailable;
std::condition_variable _cvDataConsumed;
std::atomic_bool _stopRequested{false};
std::ifstream _testDataIFS;
std::filesystem::path _testDataFile;
bool _useTestDataFile = false;
};