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
31 #include "mainbar.hpp"
33 #include <pv/devicemanager.hpp>
34 #include <pv/mainwindow.hpp>
35 #include <pv/popups/deviceoptions.hpp>
36 #include <pv/popups/channels.hpp>
37 #include <pv/util.hpp>
39 #include <libsigrok/libsigrok.hpp>
45 using std::shared_ptr;
48 using sigrok::Capability;
49 using sigrok::ConfigKey;
56 const uint64_t MainBar::MinSampleCount = 100ULL;
57 const uint64_t MainBar::MaxSampleCount = 1000000000000ULL;
58 const uint64_t MainBar::DefaultSampleCount = 1000000;
60 MainBar::MainBar(Session &session, MainWindow &main_window) :
61 QToolBar("Sampling Bar", &main_window),
63 main_window_(main_window),
64 device_selector_(this),
65 updating_device_selector_(false),
66 configure_button_(this),
67 configure_button_action_(NULL),
68 channels_button_(this),
69 sample_count_(" samples", this),
70 sample_rate_("Hz", this),
71 updating_sample_rate_(false),
72 updating_sample_count_(false),
73 sample_count_supported_(false),
74 icon_red_(":/icons/status-red.svg"),
75 icon_green_(":/icons/status-green.svg"),
76 icon_grey_(":/icons/status-grey.svg"),
77 run_stop_button_(this),
80 setObjectName(QString::fromUtf8("MainBar"));
86 QMenu *const menu = new QMenu(this);
88 QMenu *const menu_help = new QMenu;
89 menu_help->setTitle(tr("&Help"));
90 menu_help->addAction(main_window.action_about());
92 menu->addAction(menu_help->menuAction());
94 menu->addAction(main_window.action_quit());
96 menu_button_.setMenu(menu);
97 menu_button_.setPopupMode(QToolButton::InstantPopup);
98 menu_button_.setIcon(QIcon::fromTheme("menu",
99 QIcon(":/icons/menu.svg")));
102 addAction(main_window.action_open());
103 addAction(main_window.action_save_as());
105 addAction(main_window.action_view_zoom_in());
106 addAction(main_window.action_view_zoom_out());
107 addAction(main_window.action_view_zoom_fit());
108 addAction(main_window.action_view_zoom_one_to_one());
110 addAction(main_window.action_view_show_cursors());
113 connect(&run_stop_button_, SIGNAL(clicked()),
114 this, SLOT(on_run_stop()));
115 connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
116 this, SLOT(on_device_selected()));
117 connect(&sample_count_, SIGNAL(value_changed()),
118 this, SLOT(on_sample_count_changed()));
119 connect(&sample_rate_, SIGNAL(value_changed()),
120 this, SLOT(on_sample_rate_changed()));
122 sample_count_.show_min_max_step(0, UINT64_MAX, 1);
124 set_capture_state(pv::Session::Stopped);
126 configure_button_.setIcon(QIcon::fromTheme("configure",
127 QIcon(":/icons/configure.png")));
129 channels_button_.setIcon(QIcon::fromTheme("channels",
130 QIcon(":/icons/channels.svg")));
132 run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
134 addWidget(&device_selector_);
135 configure_button_action_ = addWidget(&configure_button_);
136 addWidget(&channels_button_);
137 addWidget(&sample_count_);
138 addWidget(&sample_rate_);
139 addWidget(&run_stop_button_);
141 QWidget *const spacer = new QWidget();
142 spacer->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
145 addWidget(&menu_button_);
147 sample_count_.installEventFilter(this);
148 sample_rate_.installEventFilter(this);
151 void MainBar::set_device_list(
152 const std::list< std::shared_ptr<sigrok::Device> > &devices,
153 shared_ptr<Device> selected)
155 int selected_index = -1;
159 updating_device_selector_ = true;
161 device_selector_.clear();
163 for (auto device : devices) {
166 string display_name =
167 session_.device_manager().get_display_name(device);
169 if (selected == device)
170 selected_index = device_selector_.count();
172 device_selector_.addItem(display_name.c_str(),
173 qVariantFromValue(device));
176 // The selected device should have been in the list
177 assert(selected_index != -1);
178 device_selector_.setCurrentIndex(selected_index);
180 update_device_config_widgets();
182 updating_device_selector_ = false;
185 shared_ptr<Device> MainBar::get_selected_device() const
187 const int index = device_selector_.currentIndex();
189 return shared_ptr<Device>();
191 return device_selector_.itemData(index).value<shared_ptr<Device>>();
194 void MainBar::set_capture_state(pv::Session::capture_state state)
196 const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
197 run_stop_button_.setIcon(*icons[state]);
198 run_stop_button_.setText((state == pv::Session::Stopped) ?
199 tr("Run") : tr("Stop"));
200 run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
203 void MainBar::update_sample_rate_selector()
205 Glib::VariantContainerBase gvar_dict;
207 const uint64_t *elements = NULL;
210 if (updating_sample_rate_)
213 const shared_ptr<Device> device = get_selected_device();
217 assert(!updating_sample_rate_);
218 updating_sample_rate_ = true;
220 const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
221 const auto iter = keys.find(ConfigKey::SAMPLERATE);
222 if (iter != keys.end() &&
223 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
224 const auto keys = device->config_keys(
225 ConfigKey::DEVICE_OPTIONS);
227 gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
228 } catch(const sigrok::Error &e) {
229 // Failed to enunmerate samplerate
235 sample_rate_.show_none();
236 updating_sample_rate_ = false;
240 if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
241 "samplerate-steps", G_VARIANT_TYPE("at"))))
243 elements = (const uint64_t *)g_variant_get_fixed_array(
244 gvar_list, &num_elements, sizeof(uint64_t));
246 const uint64_t min = elements[0];
247 const uint64_t max = elements[1];
248 const uint64_t step = elements[2];
250 g_variant_unref(gvar_list);
258 sample_rate_.show_125_list(min, max);
261 // When the step is not 1, we cam't make a 1-2-5-10
262 // list of sample rates, because we may not be able to
263 // make round numbers. Therefore in this case, show a
265 sample_rate_.show_min_max_step(min, max, step);
268 else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
269 "samplerates", G_VARIANT_TYPE("at"))))
271 elements = (const uint64_t *)g_variant_get_fixed_array(
272 gvar_list, &num_elements, sizeof(uint64_t));
273 sample_rate_.show_list(elements, num_elements);
274 g_variant_unref(gvar_list);
276 updating_sample_rate_ = false;
278 update_sample_rate_selector_value();
281 void MainBar::update_sample_rate_selector_value()
283 if (updating_sample_rate_)
286 const shared_ptr<Device> device = get_selected_device();
291 auto gvar = device->config_get(ConfigKey::SAMPLERATE);
292 uint64_t samplerate =
293 Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
294 assert(!updating_sample_rate_);
295 updating_sample_rate_ = true;
296 sample_rate_.set_value(samplerate);
297 updating_sample_rate_ = false;
298 } catch (Error error) {
299 qDebug() << "WARNING: Failed to get value of sample rate";
304 void MainBar::update_sample_count_selector()
306 if (updating_sample_count_)
309 const shared_ptr<Device> device = get_selected_device();
313 assert(!updating_sample_count_);
314 updating_sample_count_ = true;
316 if (!sample_count_supported_)
318 sample_count_.show_none();
319 updating_sample_count_ = false;
323 uint64_t sample_count = sample_count_.value();
324 uint64_t min_sample_count = 0;
325 uint64_t max_sample_count = MaxSampleCount;
327 if (sample_count == 0)
328 sample_count = DefaultSampleCount;
330 const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
331 const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
332 if (iter != keys.end() &&
333 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
336 device->config_list(ConfigKey::LIMIT_SAMPLES);
338 g_variant_get(gvar.gobj(), "(tt)",
339 &min_sample_count, &max_sample_count);
340 } catch(const sigrok::Error &e) {
341 // Failed to query sample limit
346 min_sample_count = min(max(min_sample_count, MinSampleCount),
349 sample_count_.show_125_list(
350 min_sample_count, max_sample_count);
353 auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
354 sample_count = g_variant_get_uint64(gvar.gobj());
355 if (sample_count == 0)
356 sample_count = DefaultSampleCount;
357 sample_count = min(max(sample_count, MinSampleCount),
359 } catch (Error error) {}
361 sample_count_.set_value(sample_count);
363 updating_sample_count_ = false;
366 void MainBar::update_device_config_widgets()
368 using namespace pv::popups;
370 const shared_ptr<Device> device = get_selected_device();
374 // Update the configure popup
375 DeviceOptions *const opts = new DeviceOptions(device, this);
376 configure_button_action_->setVisible(
377 !opts->binding().properties().empty());
378 configure_button_.set_popup(opts);
380 // Update the channels popup
381 Channels *const channels = new Channels(session_, this);
382 channels_button_.set_popup(channels);
384 // Update supported options.
385 sample_count_supported_ = false;
388 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
390 auto key = entry.first;
391 auto capabilities = entry.second;
393 case SR_CONF_LIMIT_SAMPLES:
394 if (capabilities.count(Capability::SET))
395 sample_count_supported_ = true;
397 case SR_CONF_LIMIT_FRAMES:
398 if (capabilities.count(Capability::SET))
400 device->config_set(ConfigKey::LIMIT_FRAMES,
401 Glib::Variant<guint64>::create(1));
409 } catch (Error error) {}
411 // Add notification of reconfigure events
412 disconnect(this, SLOT(on_config_changed()));
413 connect(&opts->binding(), SIGNAL(config_changed()),
414 this, SLOT(on_config_changed()));
416 // Update sweep timing widgets.
417 update_sample_count_selector();
418 update_sample_rate_selector();
421 void MainBar::commit_sample_count()
423 uint64_t sample_count = 0;
425 if (updating_sample_count_)
428 const shared_ptr<Device> device = get_selected_device();
432 sample_count = sample_count_.value();
434 // Set the sample count
435 assert(!updating_sample_count_);
436 updating_sample_count_ = true;
437 if (sample_count_supported_)
440 device->config_set(ConfigKey::LIMIT_SAMPLES,
441 Glib::Variant<guint64>::create(sample_count));
443 } catch (Error error) {
444 qDebug() << "Failed to configure sample count.";
448 updating_sample_count_ = false;
451 void MainBar::commit_sample_rate()
453 uint64_t sample_rate = 0;
455 if (updating_sample_rate_)
458 const shared_ptr<Device> device = get_selected_device();
462 sample_rate = sample_rate_.value();
463 if (sample_rate == 0)
466 // Set the samplerate
467 assert(!updating_sample_rate_);
468 updating_sample_rate_ = true;
470 device->config_set(ConfigKey::SAMPLERATE,
471 Glib::Variant<guint64>::create(sample_rate));
473 } catch (Error error) {
474 qDebug() << "Failed to configure samplerate.";
477 updating_sample_rate_ = false;
480 void MainBar::on_device_selected()
482 if (updating_device_selector_)
485 shared_ptr<Device> device = get_selected_device();
489 main_window_.select_device(device);
491 update_device_config_widgets();
494 void MainBar::on_sample_count_changed()
496 commit_sample_count();
499 void MainBar::on_sample_rate_changed()
501 commit_sample_rate();
504 void MainBar::on_run_stop()
506 commit_sample_count();
507 commit_sample_rate();
508 main_window_.run_stop();
511 void MainBar::on_config_changed()
513 commit_sample_count();
514 update_sample_count_selector();
515 commit_sample_rate();
516 update_sample_rate_selector();
519 bool MainBar::eventFilter(QObject *watched, QEvent *event)
521 if ((watched == &sample_count_ || watched == &sample_rate_) &&
522 (event->type() == QEvent::ToolTip)) {
523 double sec = (double)sample_count_.value() / sample_rate_.value();
524 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
526 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
527 QToolTip::showText(help_event->globalPos(), str);
535 } // namespace toolbars