]> sigrok.org Git - pulseview.git/blame - pv/toolbars/samplingbar.cpp
Check LIMIT_SAMPLES and SAMPLERATE are available to read before reading them
[pulseview.git] / pv / toolbars / samplingbar.cpp
CommitLineData
d4984fe7 1/*
b3f22de0 2 * This file is part of the PulseView project.
d4984fe7
JH
3 *
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5 *
6 * This program 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 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program 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 this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
09f5d123 21#include <extdef.h>
dde1a563 22
09f5d123 23#include <assert.h>
215f9499 24
dde1a563 25#include <QAction>
48888313 26#include <QDebug>
40065ab6
JS
27#include <QHelpEvent>
28#include <QToolTip>
dde1a563 29
2acdb232 30#include "samplingbar.hpp"
d4984fe7 31
2acdb232
JH
32#include <pv/devicemanager.hpp>
33#include <pv/popups/deviceoptions.hpp>
34#include <pv/popups/channels.hpp>
35#include <pv/util.hpp>
cdb50f67 36
e8d00928
ML
37#include <libsigrok/libsigrok.hpp>
38
19adbc2c 39using std::map;
e8d00928 40using std::vector;
b50ef520
JH
41using std::max;
42using std::min;
f9abf97e 43using std::shared_ptr;
819f4c25 44using std::string;
dd63af74 45
e8d00928
ML
46using sigrok::Capability;
47using sigrok::ConfigKey;
48using sigrok::Device;
49using sigrok::Error;
50
51e77110 51namespace pv {
f4c92e1c 52namespace toolbars {
51e77110 53
b50ef520
JH
54const uint64_t SamplingBar::MinSampleCount = 100ULL;
55const uint64_t SamplingBar::MaxSampleCount = 1000000000000ULL;
56const uint64_t SamplingBar::DefaultSampleCount = 1000000;
09f5d123 57
aca00b1e 58SamplingBar::SamplingBar(SigSession &session, QWidget *parent) :
6fb67b27 59 QToolBar("Sampling Bar", parent),
8dbbc7f0
JH
60 session_(session),
61 device_selector_(this),
62 updating_device_selector_(false),
63 configure_button_(this),
64 configure_button_action_(NULL),
65 channels_button_(this),
66 sample_count_(" samples", this),
67 sample_rate_("Hz", this),
68 updating_sample_rate_(false),
69 updating_sample_count_(false),
70 sample_count_supported_(false),
71 icon_red_(":/icons/status-red.svg"),
72 icon_green_(":/icons/status-green.svg"),
73 icon_grey_(":/icons/status-grey.svg"),
74 run_stop_button_(this)
6fb67b27 75{
0c7cdea2
SA
76 setObjectName(QString::fromUtf8("SamplingBar"));
77
8dbbc7f0 78 connect(&run_stop_button_, SIGNAL(clicked()),
9f3d12f3 79 this, SLOT(on_run_stop()));
8dbbc7f0 80 connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
dde1a563 81 this, SLOT(on_device_selected()));
8dbbc7f0 82 connect(&sample_count_, SIGNAL(value_changed()),
124d97de 83 this, SLOT(on_sample_count_changed()));
8dbbc7f0 84 connect(&sample_rate_, SIGNAL(value_changed()),
1198b887 85 this, SLOT(on_sample_rate_changed()));
dde1a563 86
8dbbc7f0 87 sample_count_.show_min_max_step(0, UINT64_MAX, 1);
215f9499 88
2b49eeb0 89 set_capture_state(pv::SigSession::Stopped);
274d4f13 90
8dbbc7f0 91 configure_button_.setIcon(QIcon::fromTheme("configure",
688ef645 92 QIcon(":/icons/configure.png")));
b7b659aa 93
8dbbc7f0 94 channels_button_.setIcon(QIcon::fromTheme("channels",
6ac6242b 95 QIcon(":/icons/channels.svg")));
cdb50f67 96
8dbbc7f0 97 run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
f5798068 98
8dbbc7f0
JH
99 addWidget(&device_selector_);
100 configure_button_action_ = addWidget(&configure_button_);
101 addWidget(&channels_button_);
102 addWidget(&sample_count_);
103 addWidget(&sample_rate_);
6fb67b27 104
8dbbc7f0 105 addWidget(&run_stop_button_);
40065ab6 106
8dbbc7f0
JH
107 sample_count_.installEventFilter(this);
108 sample_rate_.installEventFilter(this);
6fb67b27
JH
109}
110
18203d86 111void SamplingBar::set_device_list(
4fe06f49 112 const std::list< std::pair<std::shared_ptr<sigrok::Device>, std::string> > &devices,
e8d00928 113 shared_ptr<Device> selected)
18203d86 114{
e95e8563
JH
115 int selected_index = -1;
116
117 assert(selected);
118
8dbbc7f0 119 updating_device_selector_ = true;
95237c18 120
8dbbc7f0 121 device_selector_.clear();
18203d86 122
4fe06f49 123 for (auto entry : devices) {
e8d00928 124 auto device = entry.first;
4fe06f49 125 auto display_name = entry.second;
19adbc2c 126
e8d00928
ML
127 assert(device);
128
129 if (selected == device)
8dbbc7f0 130 selected_index = device_selector_.count();
e95e8563 131
8dbbc7f0 132 device_selector_.addItem(display_name.c_str(),
e8d00928 133 qVariantFromValue(device));
18203d86
JH
134 }
135
e95e8563
JH
136 // The selected device should have been in the list
137 assert(selected_index != -1);
8dbbc7f0 138 device_selector_.setCurrentIndex(selected_index);
e95e8563
JH
139
140 update_device_config_widgets();
141
8dbbc7f0 142 updating_device_selector_ = false;
18203d86
JH
143}
144
e8d00928 145shared_ptr<Device> SamplingBar::get_selected_device() const
d4984fe7 146{
8dbbc7f0 147 const int index = device_selector_.currentIndex();
333d5bbc 148 if (index < 0)
e8d00928 149 return shared_ptr<Device>();
6fb67b27 150
8dbbc7f0 151 return device_selector_.itemData(index).value<shared_ptr<Device>>();
6fb67b27
JH
152}
153
2b49eeb0 154void SamplingBar::set_capture_state(pv::SigSession::capture_state state)
6ac96c2e 155{
8dbbc7f0
JH
156 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
157 run_stop_button_.setIcon(*icons[state]);
158 run_stop_button_.setText((state == pv::SigSession::Stopped) ?
2b49eeb0 159 tr("Run") : tr("Stop"));
8dbbc7f0 160 run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
6ac96c2e
JH
161}
162
dde1a563
JH
163void SamplingBar::update_sample_rate_selector()
164{
e8d00928
ML
165 Glib::VariantContainerBase gvar_dict;
166 GVariant *gvar_list;
488f5d3f
BV
167 const uint64_t *elements = NULL;
168 gsize num_elements;
dde1a563 169
8dbbc7f0 170 if (updating_sample_rate_)
3d4f16af
JH
171 return;
172
e8d00928
ML
173 const shared_ptr<Device> device = get_selected_device();
174 if (!device)
ef4d0201
JH
175 return;
176
8dbbc7f0
JH
177 assert(!updating_sample_rate_);
178 updating_sample_rate_ = true;
1198b887 179
ed1d9d81
JH
180 const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
181 const auto iter = keys.find(ConfigKey::SAMPLERATE);
182 if (iter != keys.end() &&
183 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
e8d00928 184 gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
ed1d9d81 185 } else {
8dbbc7f0
JH
186 sample_rate_.show_none();
187 updating_sample_rate_ = false;
dde1a563 188 return;
1198b887 189 }
dde1a563 190
e8d00928 191 if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
1198b887
JH
192 "samplerate-steps", G_VARIANT_TYPE("at"))))
193 {
488f5d3f
BV
194 elements = (const uint64_t *)g_variant_get_fixed_array(
195 gvar_list, &num_elements, sizeof(uint64_t));
aafe53af
JH
196
197 const uint64_t min = elements[0];
198 const uint64_t max = elements[1];
199 const uint64_t step = elements[2];
200
488f5d3f 201 g_variant_unref(gvar_list);
aafe53af
JH
202
203 assert(min > 0);
204 assert(max > 0);
205 assert(max > min);
206 assert(step > 0);
207
208 if (step == 1)
8dbbc7f0 209 sample_rate_.show_125_list(min, max);
aafe53af
JH
210 else
211 {
212 // When the step is not 1, we cam't make a 1-2-5-10
213 // list of sample rates, because we may not be able to
214 // make round numbers. Therefore in this case, show a
215 // spin box.
8dbbc7f0 216 sample_rate_.show_min_max_step(min, max, step);
aafe53af 217 }
dde1a563 218 }
e8d00928 219 else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
488f5d3f 220 "samplerates", G_VARIANT_TYPE("at"))))
dde1a563 221 {
488f5d3f
BV
222 elements = (const uint64_t *)g_variant_get_fixed_array(
223 gvar_list, &num_elements, sizeof(uint64_t));
8dbbc7f0 224 sample_rate_.show_list(elements, num_elements);
488f5d3f 225 g_variant_unref(gvar_list);
dde1a563 226 }
8dbbc7f0 227 updating_sample_rate_ = false;
48888313
JH
228
229 update_sample_rate_selector_value();
230}
231
232void SamplingBar::update_sample_rate_selector_value()
233{
8dbbc7f0 234 if (updating_sample_rate_)
3d4f16af
JH
235 return;
236
e8d00928
ML
237 const shared_ptr<Device> device = get_selected_device();
238 if (!device)
19adbc2c
JH
239 return;
240
e8d00928
ML
241 try {
242 auto gvar = device->config_get(ConfigKey::SAMPLERATE);
243 uint64_t samplerate =
15289d5c 244 Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
8dbbc7f0
JH
245 assert(!updating_sample_rate_);
246 updating_sample_rate_ = true;
247 sample_rate_.set_value(samplerate);
248 updating_sample_rate_ = false;
e8d00928 249 } catch (Error error) {
8dd44190 250 qDebug() << "WARNING: Failed to get value of sample rate";
eb4008a6
JH
251 return;
252 }
48888313
JH
253}
254
85756012
ML
255void SamplingBar::update_sample_count_selector()
256{
8dbbc7f0 257 if (updating_sample_count_)
3d4f16af
JH
258 return;
259
e8d00928
ML
260 const shared_ptr<Device> device = get_selected_device();
261 if (!device)
19adbc2c
JH
262 return;
263
8dbbc7f0
JH
264 assert(!updating_sample_count_);
265 updating_sample_count_ = true;
85756012 266
3e7636f9 267 if (!sample_count_supported_)
df3c1aa3 268 {
3e7636f9
JH
269 sample_count_.show_none();
270 updating_sample_count_ = false;
271 return;
272 }
b50ef520 273
3e7636f9
JH
274 uint64_t sample_count = sample_count_.value();
275 uint64_t min_sample_count = 0;
276 uint64_t max_sample_count = MaxSampleCount;
3cbffdcf 277
3e7636f9
JH
278 if (sample_count == 0)
279 sample_count = DefaultSampleCount;
b50ef520 280
ed1d9d81
JH
281 const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
282 const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
283 if (iter != keys.end() &&
284 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
3e7636f9
JH
285 auto gvar = device->config_list(ConfigKey::LIMIT_SAMPLES);
286 g_variant_get(gvar.gobj(), "(tt)",
287 &min_sample_count, &max_sample_count);
ed1d9d81 288 }
1d04852f 289
3e7636f9
JH
290 min_sample_count = min(max(min_sample_count, MinSampleCount),
291 max_sample_count);
b50ef520 292
3e7636f9
JH
293 sample_count_.show_125_list(
294 min_sample_count, max_sample_count);
b50ef520 295
3e7636f9
JH
296 try {
297 auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
298 sample_count = g_variant_get_uint64(gvar.gobj());
299 if (sample_count == 0)
300 sample_count = DefaultSampleCount;
301 sample_count = min(max(sample_count, MinSampleCount),
302 max_sample_count);
303 } catch (Error error) {}
304
305 sample_count_.set_value(sample_count);
df3c1aa3 306
8dbbc7f0 307 updating_sample_count_ = false;
85756012
ML
308}
309
e95e8563
JH
310void SamplingBar::update_device_config_widgets()
311{
e95e8563
JH
312 using namespace pv::popups;
313
e8d00928
ML
314 const shared_ptr<Device> device = get_selected_device();
315 if (!device)
e95e8563
JH
316 return;
317
318 // Update the configure popup
e8d00928 319 DeviceOptions *const opts = new DeviceOptions(device, this);
8dbbc7f0 320 configure_button_action_->setVisible(
e95e8563 321 !opts->binding().properties().empty());
8dbbc7f0 322 configure_button_.set_popup(opts);
e95e8563 323
6ac6242b 324 // Update the channels popup
8dbbc7f0
JH
325 Channels *const channels = new Channels(session_, this);
326 channels_button_.set_popup(channels);
e95e8563
JH
327
328 // Update supported options.
8dbbc7f0 329 sample_count_supported_ = false;
e95e8563 330
e8d00928
ML
331 try {
332 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
e95e8563 333 {
e8d00928
ML
334 auto key = entry.first;
335 auto capabilities = entry.second;
336 switch (key->id()) {
e95e8563 337 case SR_CONF_LIMIT_SAMPLES:
e8d00928 338 if (capabilities.count(Capability::SET))
8dbbc7f0 339 sample_count_supported_ = true;
e95e8563
JH
340 break;
341 case SR_CONF_LIMIT_FRAMES:
e8d00928
ML
342 if (capabilities.count(Capability::SET))
343 {
344 device->config_set(ConfigKey::LIMIT_FRAMES,
15289d5c 345 Glib::Variant<guint64>::create(1));
e8d00928
ML
346 on_config_changed();
347 }
348 break;
349 default:
e95e8563
JH
350 break;
351 }
352 }
e8d00928 353 } catch (Error error) {}
e95e8563
JH
354
355 // Add notification of reconfigure events
356 disconnect(this, SLOT(on_config_changed()));
e8d00928 357 connect(&opts->binding(), SIGNAL(config_changed()),
e95e8563
JH
358 this, SLOT(on_config_changed()));
359
360 // Update sweep timing widgets.
361 update_sample_count_selector();
362 update_sample_rate_selector();
363}
364
124d97de
ML
365void SamplingBar::commit_sample_count()
366{
367 uint64_t sample_count = 0;
368
8dbbc7f0 369 if (updating_sample_count_)
3d4f16af
JH
370 return;
371
e8d00928
ML
372 const shared_ptr<Device> device = get_selected_device();
373 if (!device)
19adbc2c
JH
374 return;
375
8dbbc7f0 376 sample_count = sample_count_.value();
124d97de
ML
377
378 // Set the sample count
8dbbc7f0
JH
379 assert(!updating_sample_count_);
380 updating_sample_count_ = true;
381 if (sample_count_supported_)
e8d00928
ML
382 {
383 try {
384 device->config_set(ConfigKey::LIMIT_SAMPLES,
15289d5c 385 Glib::Variant<guint64>::create(sample_count));
e8d00928
ML
386 on_config_changed();
387 } catch (Error error) {
388 qDebug() << "Failed to configure sample count.";
389 return;
390 }
124d97de 391 }
8dbbc7f0 392 updating_sample_count_ = false;
124d97de
ML
393}
394
48888313
JH
395void SamplingBar::commit_sample_rate()
396{
397 uint64_t sample_rate = 0;
398
8dbbc7f0 399 if (updating_sample_rate_)
3d4f16af
JH
400 return;
401
e8d00928
ML
402 const shared_ptr<Device> device = get_selected_device();
403 if (!device)
19adbc2c
JH
404 return;
405
8dbbc7f0 406 sample_rate = sample_rate_.value();
f9541bde
JH
407 if (sample_rate == 0)
408 return;
409
48888313 410 // Set the samplerate
8dbbc7f0
JH
411 assert(!updating_sample_rate_);
412 updating_sample_rate_ = true;
e8d00928
ML
413 try {
414 device->config_set(ConfigKey::SAMPLERATE,
15289d5c 415 Glib::Variant<guint64>::create(sample_rate));
e8d00928
ML
416 on_config_changed();
417 } catch (Error error) {
48888313
JH
418 qDebug() << "Failed to configure samplerate.";
419 return;
420 }
8dbbc7f0 421 updating_sample_rate_ = false;
dde1a563
JH
422}
423
424void SamplingBar::on_device_selected()
425{
8dbbc7f0 426 if (updating_device_selector_)
95237c18
JH
427 return;
428
e8d00928
ML
429 shared_ptr<Device> device = get_selected_device();
430 if (!device)
19adbc2c
JH
431 return;
432
8dbbc7f0 433 session_.set_device(device);
51d4a9ab 434
e95e8563 435 update_device_config_widgets();
dde1a563 436}
51e77110 437
124d97de
ML
438void SamplingBar::on_sample_count_changed()
439{
3d4f16af 440 commit_sample_count();
124d97de
ML
441}
442
48888313
JH
443void SamplingBar::on_sample_rate_changed()
444{
3d4f16af 445 commit_sample_rate();
48888313
JH
446}
447
9f3d12f3
JH
448void SamplingBar::on_run_stop()
449{
b50ef520 450 commit_sample_count();
9f3d12f3
JH
451 commit_sample_rate();
452 run_stop();
453}
454
82afd5e3
JH
455void SamplingBar::on_config_changed()
456{
457 commit_sample_count();
458 update_sample_count_selector();
459 commit_sample_rate();
460 update_sample_rate_selector();
461}
462
40065ab6
JS
463bool SamplingBar::eventFilter(QObject *watched, QEvent *event)
464{
8dbbc7f0 465 if ((watched == &sample_count_ || watched == &sample_rate_) &&
40065ab6 466 (event->type() == QEvent::ToolTip)) {
8dbbc7f0 467 double sec = (double)sample_count_.value() / sample_rate_.value();
40065ab6 468 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
62974f45
JS
469
470 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
40065ab6
JS
471 QToolTip::showText(help_event->globalPos(), str);
472
473 return true;
474 }
475
476 return false;
477}
478
f4c92e1c 479} // namespace toolbars
51e77110 480} // namespace pv