2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
30 #include "samplingbar.hpp"
32 #include <pv/devicemanager.hpp>
33 #include <pv/popups/deviceoptions.hpp>
34 #include <pv/popups/channels.hpp>
35 #include <pv/util.hpp>
37 #include <libsigrok/libsigrok.hpp>
43 using std::shared_ptr;
46 using sigrok::Capability;
47 using sigrok::ConfigKey;
54 const uint64_t SamplingBar::MinSampleCount = 100ULL;
55 const uint64_t SamplingBar::MaxSampleCount = 1000000000000ULL;
56 const uint64_t SamplingBar::DefaultSampleCount = 1000000;
58 SamplingBar::SamplingBar(SigSession &session, QWidget *parent) :
59 QToolBar("Sampling Bar", parent),
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)
76 setObjectName(QString::fromUtf8("SamplingBar"));
78 connect(&run_stop_button_, SIGNAL(clicked()),
79 this, SLOT(on_run_stop()));
80 connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
81 this, SLOT(on_device_selected()));
82 connect(&sample_count_, SIGNAL(value_changed()),
83 this, SLOT(on_sample_count_changed()));
84 connect(&sample_rate_, SIGNAL(value_changed()),
85 this, SLOT(on_sample_rate_changed()));
87 sample_count_.show_min_max_step(0, UINT64_MAX, 1);
89 set_capture_state(pv::SigSession::Stopped);
91 configure_button_.setIcon(QIcon::fromTheme("configure",
92 QIcon(":/icons/configure.png")));
94 channels_button_.setIcon(QIcon::fromTheme("channels",
95 QIcon(":/icons/channels.svg")));
97 run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
99 addWidget(&device_selector_);
100 configure_button_action_ = addWidget(&configure_button_);
101 addWidget(&channels_button_);
102 addWidget(&sample_count_);
103 addWidget(&sample_rate_);
105 addWidget(&run_stop_button_);
107 sample_count_.installEventFilter(this);
108 sample_rate_.installEventFilter(this);
111 void SamplingBar::set_device_list(
112 const std::list< std::pair<std::shared_ptr<sigrok::Device>, std::string> > &devices,
113 shared_ptr<Device> selected)
115 int selected_index = -1;
119 updating_device_selector_ = true;
121 device_selector_.clear();
123 for (auto entry : devices) {
124 auto device = entry.first;
125 auto display_name = entry.second;
129 if (selected == device)
130 selected_index = device_selector_.count();
132 device_selector_.addItem(display_name.c_str(),
133 qVariantFromValue(device));
136 // The selected device should have been in the list
137 assert(selected_index != -1);
138 device_selector_.setCurrentIndex(selected_index);
140 update_device_config_widgets();
142 updating_device_selector_ = false;
145 shared_ptr<Device> SamplingBar::get_selected_device() const
147 const int index = device_selector_.currentIndex();
149 return shared_ptr<Device>();
151 return device_selector_.itemData(index).value<shared_ptr<Device>>();
154 void SamplingBar::set_capture_state(pv::SigSession::capture_state state)
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) ?
159 tr("Run") : tr("Stop"));
160 run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
163 void SamplingBar::update_sample_rate_selector()
165 Glib::VariantContainerBase gvar_dict;
167 const uint64_t *elements = NULL;
170 if (updating_sample_rate_)
173 const shared_ptr<Device> device = get_selected_device();
177 assert(!updating_sample_rate_);
178 updating_sample_rate_ = true;
181 gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
182 } catch (Error error) {
183 sample_rate_.show_none();
184 updating_sample_rate_ = false;
188 if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
189 "samplerate-steps", G_VARIANT_TYPE("at"))))
191 elements = (const uint64_t *)g_variant_get_fixed_array(
192 gvar_list, &num_elements, sizeof(uint64_t));
194 const uint64_t min = elements[0];
195 const uint64_t max = elements[1];
196 const uint64_t step = elements[2];
198 g_variant_unref(gvar_list);
206 sample_rate_.show_125_list(min, max);
209 // When the step is not 1, we cam't make a 1-2-5-10
210 // list of sample rates, because we may not be able to
211 // make round numbers. Therefore in this case, show a
213 sample_rate_.show_min_max_step(min, max, step);
216 else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
217 "samplerates", G_VARIANT_TYPE("at"))))
219 elements = (const uint64_t *)g_variant_get_fixed_array(
220 gvar_list, &num_elements, sizeof(uint64_t));
221 sample_rate_.show_list(elements, num_elements);
222 g_variant_unref(gvar_list);
224 updating_sample_rate_ = false;
226 update_sample_rate_selector_value();
229 void SamplingBar::update_sample_rate_selector_value()
231 if (updating_sample_rate_)
234 const shared_ptr<Device> device = get_selected_device();
239 auto gvar = device->config_get(ConfigKey::SAMPLERATE);
240 uint64_t samplerate =
241 Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
242 assert(!updating_sample_rate_);
243 updating_sample_rate_ = true;
244 sample_rate_.set_value(samplerate);
245 updating_sample_rate_ = false;
246 } catch (Error error) {
247 qDebug() << "WARNING: Failed to get value of sample rate";
252 void SamplingBar::update_sample_count_selector()
254 if (updating_sample_count_)
257 const shared_ptr<Device> device = get_selected_device();
261 assert(!updating_sample_count_);
262 updating_sample_count_ = true;
264 if (sample_count_supported_)
266 uint64_t sample_count = sample_count_.value();
267 uint64_t min_sample_count = 0;
268 uint64_t max_sample_count = MaxSampleCount;
270 if (sample_count == 0)
271 sample_count = DefaultSampleCount;
274 auto gvar = device->config_list(ConfigKey::LIMIT_SAMPLES);
275 g_variant_get(gvar.gobj(), "(tt)",
276 &min_sample_count, &max_sample_count);
277 } catch (Error error) {}
279 min_sample_count = min(max(min_sample_count, MinSampleCount),
282 sample_count_.show_125_list(
283 min_sample_count, max_sample_count);
286 auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
287 sample_count = g_variant_get_uint64(gvar.gobj());
288 if (sample_count == 0)
289 sample_count = DefaultSampleCount;
290 sample_count = min(max(sample_count, MinSampleCount),
292 } catch (Error error) {}
294 sample_count_.set_value(sample_count);
297 sample_count_.show_none();
299 updating_sample_count_ = false;
302 void SamplingBar::update_device_config_widgets()
304 using namespace pv::popups;
306 const shared_ptr<Device> device = get_selected_device();
310 // Update the configure popup
311 DeviceOptions *const opts = new DeviceOptions(device, this);
312 configure_button_action_->setVisible(
313 !opts->binding().properties().empty());
314 configure_button_.set_popup(opts);
316 // Update the channels popup
317 Channels *const channels = new Channels(session_, this);
318 channels_button_.set_popup(channels);
320 // Update supported options.
321 sample_count_supported_ = false;
324 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
326 auto key = entry.first;
327 auto capabilities = entry.second;
329 case SR_CONF_LIMIT_SAMPLES:
330 if (capabilities.count(Capability::SET))
331 sample_count_supported_ = true;
333 case SR_CONF_LIMIT_FRAMES:
334 if (capabilities.count(Capability::SET))
336 device->config_set(ConfigKey::LIMIT_FRAMES,
337 Glib::Variant<guint64>::create(1));
345 } catch (Error error) {}
347 // Add notification of reconfigure events
348 disconnect(this, SLOT(on_config_changed()));
349 connect(&opts->binding(), SIGNAL(config_changed()),
350 this, SLOT(on_config_changed()));
352 // Update sweep timing widgets.
353 update_sample_count_selector();
354 update_sample_rate_selector();
357 void SamplingBar::commit_sample_count()
359 uint64_t sample_count = 0;
361 if (updating_sample_count_)
364 const shared_ptr<Device> device = get_selected_device();
368 sample_count = sample_count_.value();
370 // Set the sample count
371 assert(!updating_sample_count_);
372 updating_sample_count_ = true;
373 if (sample_count_supported_)
376 device->config_set(ConfigKey::LIMIT_SAMPLES,
377 Glib::Variant<guint64>::create(sample_count));
379 } catch (Error error) {
380 qDebug() << "Failed to configure sample count.";
384 updating_sample_count_ = false;
387 void SamplingBar::commit_sample_rate()
389 uint64_t sample_rate = 0;
391 if (updating_sample_rate_)
394 const shared_ptr<Device> device = get_selected_device();
398 sample_rate = sample_rate_.value();
399 if (sample_rate == 0)
402 // Set the samplerate
403 assert(!updating_sample_rate_);
404 updating_sample_rate_ = true;
406 device->config_set(ConfigKey::SAMPLERATE,
407 Glib::Variant<guint64>::create(sample_rate));
409 } catch (Error error) {
410 qDebug() << "Failed to configure samplerate.";
413 updating_sample_rate_ = false;
416 void SamplingBar::on_device_selected()
418 if (updating_device_selector_)
421 shared_ptr<Device> device = get_selected_device();
425 session_.set_device(device);
427 update_device_config_widgets();
430 void SamplingBar::on_sample_count_changed()
432 commit_sample_count();
435 void SamplingBar::on_sample_rate_changed()
437 commit_sample_rate();
440 void SamplingBar::on_run_stop()
442 commit_sample_count();
443 commit_sample_rate();
447 void SamplingBar::on_config_changed()
449 commit_sample_count();
450 update_sample_count_selector();
451 commit_sample_rate();
452 update_sample_rate_selector();
455 bool SamplingBar::eventFilter(QObject *watched, QEvent *event)
457 if ((watched == &sample_count_ || watched == &sample_rate_) &&
458 (event->type() == QEvent::ToolTip)) {
459 double sec = (double)sample_count_.value() / sample_rate_.value();
460 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
462 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
463 QToolTip::showText(help_event->globalPos(), str);
471 } // namespace toolbars