2 * This file is part of the PulseView project.
4 * Copyright (C) 2012-2015 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, see <http://www.gnu.org/licenses/>.
27 #include <QFileDialog>
30 #include <QMessageBox>
34 #include "mainbar.hpp"
36 #include <boost/algorithm/string/join.hpp>
38 #include <pv/devicemanager.hpp>
39 #include <pv/devices/hardwaredevice.hpp>
40 #include <pv/devices/inputfile.hpp>
41 #include <pv/devices/sessionfile.hpp>
42 #include <pv/dialogs/connect.hpp>
43 #include <pv/dialogs/inputoutputoptions.hpp>
44 #include <pv/dialogs/storeprogress.hpp>
45 #include <pv/mainwindow.hpp>
46 #include <pv/popups/deviceoptions.hpp>
47 #include <pv/popups/channels.hpp>
48 #include <pv/util.hpp>
49 #include <pv/view/view.hpp>
50 #include <pv/widgets/exportmenu.hpp>
51 #include <pv/widgets/importmenu.hpp>
53 #include <pv/widgets/decodermenu.hpp>
56 #include <libsigrokcxx/libsigrokcxx.hpp>
58 using std::back_inserter;
66 using std::shared_ptr;
70 using sigrok::Capability;
71 using sigrok::ConfigKey;
73 using sigrok::InputFormat;
74 using sigrok::OutputFormat;
76 using boost::algorithm::join;
81 const uint64_t MainBar::MinSampleCount = 100ULL;
82 const uint64_t MainBar::MaxSampleCount = 1000000000000ULL;
83 const uint64_t MainBar::DefaultSampleCount = 1000000;
85 const char *MainBar::SettingOpenDirectory = "MainWindow/OpenDirectory";
86 const char *MainBar::SettingSaveDirectory = "MainWindow/SaveDirectory";
88 MainBar::MainBar(Session &session, QWidget *parent,
89 pv::views::TraceView::View *view) :
90 StandardBar(session, parent, view, false),
91 action_new_view_(new QAction(this)),
92 action_open_(new QAction(this)),
93 action_save_as_(new QAction(this)),
94 action_save_selection_as_(new QAction(this)),
95 action_connect_(new QAction(this)),
96 open_button_(new QToolButton()),
97 save_button_(new QToolButton()),
98 device_selector_(parent, session.device_manager(),
100 configure_button_(this),
101 configure_button_action_(nullptr),
102 channels_button_(this),
103 channels_button_action_(nullptr),
104 sample_count_(" samples", this),
105 sample_rate_("Hz", this),
106 updating_sample_rate_(false),
107 updating_sample_count_(false),
108 sample_count_supported_(false)
110 , add_decoder_button_(new QToolButton()),
111 menu_decoders_add_(new pv::widgets::DecoderMenu(this, true))
114 setObjectName(QString::fromUtf8("MainBar"));
117 action_new_view_->setText(tr("New &View"));
118 action_new_view_->setIcon(QIcon::fromTheme("window-new",
119 QIcon(":/icons/window-new.png")));
120 connect(action_new_view_, SIGNAL(triggered(bool)),
121 this, SLOT(on_actionNewView_triggered()));
123 action_open_->setText(tr("&Open..."));
124 action_open_->setIcon(QIcon::fromTheme("document-open",
125 QIcon(":/icons/document-open.png")));
126 action_open_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_O));
127 connect(action_open_, SIGNAL(triggered(bool)),
128 this, SLOT(on_actionOpen_triggered()));
130 action_save_as_->setText(tr("&Save As..."));
131 action_save_as_->setIcon(QIcon::fromTheme("document-save-as",
132 QIcon(":/icons/document-save-as.png")));
133 action_save_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
134 connect(action_save_as_, SIGNAL(triggered(bool)),
135 this, SLOT(on_actionSaveAs_triggered()));
137 action_save_selection_as_->setText(tr("Save Selected &Range As..."));
138 action_save_selection_as_->setIcon(QIcon::fromTheme("document-save-as",
139 QIcon(":/icons/document-save-as.png")));
140 action_save_selection_as_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_R));
141 connect(action_save_selection_as_, SIGNAL(triggered(bool)),
142 this, SLOT(on_actionSaveSelectionAs_triggered()));
144 widgets::ExportMenu *menu_file_export = new widgets::ExportMenu(this,
145 session.device_manager().context());
146 menu_file_export->setTitle(tr("&Export"));
147 connect(menu_file_export,
148 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
149 this, SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
151 widgets::ImportMenu *menu_file_import = new widgets::ImportMenu(this,
152 session.device_manager().context());
153 menu_file_import->setTitle(tr("&Import"));
154 connect(menu_file_import,
155 SIGNAL(format_selected(std::shared_ptr<sigrok::InputFormat>)),
156 this, SLOT(import_file(std::shared_ptr<sigrok::InputFormat>)));
158 action_connect_->setText(tr("&Connect to Device..."));
159 connect(action_connect_, SIGNAL(triggered(bool)),
160 this, SLOT(on_actionConnect_triggered()));
163 widgets::ImportMenu *import_menu = new widgets::ImportMenu(this,
164 session.device_manager().context(), action_open_);
166 SIGNAL(format_selected(std::shared_ptr<sigrok::InputFormat>)),
168 SLOT(import_file(std::shared_ptr<sigrok::InputFormat>)));
170 open_button_->setMenu(import_menu);
171 open_button_->setDefaultAction(action_open_);
172 open_button_->setPopupMode(QToolButton::MenuButtonPopup);
175 vector<QAction *> open_actions;
176 open_actions.push_back(action_save_as_);
177 open_actions.push_back(action_save_selection_as_);
179 widgets::ExportMenu *export_menu = new widgets::ExportMenu(this,
180 session.device_manager().context(),
183 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
185 SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
187 save_button_->setMenu(export_menu);
188 save_button_->setDefaultAction(action_save_as_);
189 save_button_->setPopupMode(QToolButton::MenuButtonPopup);
191 // Device selector menu
192 connect(&device_selector_, SIGNAL(device_selected()),
193 this, SLOT(on_device_selected()));
195 // Setup the decoder button
197 menu_decoders_add_->setTitle(tr("&Add"));
198 connect(menu_decoders_add_, SIGNAL(decoder_selected(srd_decoder*)),
199 this, SLOT(add_decoder(srd_decoder*)));
201 add_decoder_button_->setIcon(QIcon::fromTheme("add-decoder",
202 QIcon(":/icons/add-decoder.svg")));
203 add_decoder_button_->setPopupMode(QToolButton::InstantPopup);
204 add_decoder_button_->setMenu(menu_decoders_add_);
207 connect(&sample_count_, SIGNAL(value_changed()),
208 this, SLOT(on_sample_count_changed()));
209 connect(&sample_rate_, SIGNAL(value_changed()),
210 this, SLOT(on_sample_rate_changed()));
212 sample_count_.show_min_max_step(0, UINT64_MAX, 1);
214 set_capture_state(pv::Session::Stopped);
216 configure_button_.setToolTip(tr("Configure Device"));
217 configure_button_.setIcon(QIcon::fromTheme("configure",
218 QIcon(":/icons/configure.png")));
220 channels_button_.setToolTip(tr("Configure Channels"));
221 channels_button_.setIcon(QIcon::fromTheme("channels",
222 QIcon(":/icons/channels.svg")));
224 add_toolbar_widgets();
226 sample_count_.installEventFilter(this);
227 sample_rate_.installEventFilter(this);
229 // Setup session_ events
230 connect(&session_, SIGNAL(capture_state_changed(int)),
231 this, SLOT(on_capture_state_changed(int)));
232 connect(&session, SIGNAL(device_changed()),
233 this, SLOT(on_device_changed()));
235 update_device_list();
238 void MainBar::update_device_list()
240 DeviceManager &mgr = session_.device_manager();
241 shared_ptr<devices::Device> selected_device = session_.device();
242 list< shared_ptr<devices::Device> > devs;
244 copy(mgr.devices().begin(), mgr.devices().end(), back_inserter(devs));
246 if (std::find(devs.begin(), devs.end(), selected_device) == devs.end())
247 devs.push_back(selected_device);
249 device_selector_.set_device_list(devs, selected_device);
250 update_device_config_widgets();
254 void MainBar::set_capture_state(pv::Session::capture_state state)
256 bool ui_enabled = (state == pv::Session::Stopped) ? true : false;
258 device_selector_.setEnabled(ui_enabled);
259 configure_button_.setEnabled(ui_enabled);
260 channels_button_.setEnabled(ui_enabled);
261 sample_count_.setEnabled(ui_enabled);
262 sample_rate_.setEnabled(ui_enabled);
265 void MainBar::reset_device_selector()
267 device_selector_.reset();
270 QAction* MainBar::action_open() const
275 QAction* MainBar::action_save_as() const
277 return action_save_as_;
280 QAction* MainBar::action_save_selection_as() const
282 return action_save_selection_as_;
285 QAction* MainBar::action_connect() const
287 return action_connect_;
290 void MainBar::update_sample_rate_selector()
292 Glib::VariantContainerBase gvar_dict;
294 const uint64_t *elements = nullptr;
296 map< const ConfigKey*, std::set<Capability> > keys;
298 if (updating_sample_rate_) {
299 sample_rate_.show_none();
303 const shared_ptr<devices::Device> device =
304 device_selector_.selected_device();
308 assert(!updating_sample_rate_);
309 updating_sample_rate_ = true;
311 const shared_ptr<sigrok::Device> sr_dev = device->device();
313 if (sr_dev->config_check(ConfigKey::SAMPLERATE, Capability::LIST)) {
314 gvar_dict = sr_dev->config_list(ConfigKey::SAMPLERATE);
316 sample_rate_.show_none();
317 updating_sample_rate_ = false;
321 if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
322 "samplerate-steps", G_VARIANT_TYPE("at")))) {
323 elements = (const uint64_t *)g_variant_get_fixed_array(
324 gvar_list, &num_elements, sizeof(uint64_t));
326 const uint64_t min = elements[0];
327 const uint64_t max = elements[1];
328 const uint64_t step = elements[2];
330 g_variant_unref(gvar_list);
338 sample_rate_.show_125_list(min, max);
340 // When the step is not 1, we cam't make a 1-2-5-10
341 // list of sample rates, because we may not be able to
342 // make round numbers. Therefore in this case, show a
344 sample_rate_.show_min_max_step(min, max, step);
346 } else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
347 "samplerates", G_VARIANT_TYPE("at")))) {
348 elements = (const uint64_t *)g_variant_get_fixed_array(
349 gvar_list, &num_elements, sizeof(uint64_t));
350 sample_rate_.show_list(elements, num_elements);
351 g_variant_unref(gvar_list);
353 updating_sample_rate_ = false;
355 update_sample_rate_selector_value();
358 void MainBar::update_sample_rate_selector_value()
360 if (updating_sample_rate_)
363 const shared_ptr<devices::Device> device =
364 device_selector_.selected_device();
369 auto gvar = device->device()->config_get(ConfigKey::SAMPLERATE);
370 uint64_t samplerate =
371 Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
372 assert(!updating_sample_rate_);
373 updating_sample_rate_ = true;
374 sample_rate_.set_value(samplerate);
375 updating_sample_rate_ = false;
376 } catch (Error error) {
377 qDebug() << "WARNING: Failed to get value of sample rate";
382 void MainBar::update_sample_count_selector()
384 if (updating_sample_count_)
387 const shared_ptr<devices::Device> device =
388 device_selector_.selected_device();
392 const shared_ptr<sigrok::Device> sr_dev = device->device();
394 assert(!updating_sample_count_);
395 updating_sample_count_ = true;
397 if (!sample_count_supported_) {
398 sample_count_.show_none();
399 updating_sample_count_ = false;
403 uint64_t sample_count = sample_count_.value();
404 uint64_t min_sample_count = 0;
405 uint64_t max_sample_count = MaxSampleCount;
407 if (sample_count == 0)
408 sample_count = DefaultSampleCount;
410 if (sr_dev->config_check(ConfigKey::LIMIT_SAMPLES, Capability::LIST)) {
411 auto gvar = sr_dev->config_list(ConfigKey::LIMIT_SAMPLES);
413 g_variant_get(gvar.gobj(), "(tt)",
414 &min_sample_count, &max_sample_count);
417 min_sample_count = min(max(min_sample_count, MinSampleCount),
420 sample_count_.show_125_list(
421 min_sample_count, max_sample_count);
423 if (sr_dev->config_check(ConfigKey::LIMIT_SAMPLES, Capability::GET)) {
424 auto gvar = sr_dev->config_get(ConfigKey::LIMIT_SAMPLES);
425 sample_count = g_variant_get_uint64(gvar.gobj());
426 if (sample_count == 0)
427 sample_count = DefaultSampleCount;
428 sample_count = min(max(sample_count, MinSampleCount),
432 sample_count_.set_value(sample_count);
434 updating_sample_count_ = false;
437 void MainBar::update_device_config_widgets()
439 using namespace pv::popups;
441 const shared_ptr<devices::Device> device =
442 device_selector_.selected_device();
444 // Hide the widgets if no device is selected
445 channels_button_action_->setVisible(!!device);
447 configure_button_action_->setVisible(false);
448 sample_count_.show_none();
449 sample_rate_.show_none();
453 const shared_ptr<sigrok::Device> sr_dev = device->device();
457 // Update the configure popup
458 DeviceOptions *const opts = new DeviceOptions(sr_dev, this);
459 configure_button_action_->setVisible(
460 !opts->binding().properties().empty());
461 configure_button_.set_popup(opts);
463 // Update the channels popup
464 Channels *const channels = new Channels(session_, this);
465 channels_button_.set_popup(channels);
467 // Update supported options.
468 sample_count_supported_ = false;
470 if (sr_dev->config_check(ConfigKey::LIMIT_SAMPLES, Capability::SET))
471 sample_count_supported_ = true;
473 if (sr_dev->config_check(ConfigKey::LIMIT_FRAMES, Capability::SET)) {
474 sr_dev->config_set(ConfigKey::LIMIT_FRAMES,
475 Glib::Variant<guint64>::create(1));
479 // Add notification of reconfigure events
480 disconnect(this, SLOT(on_config_changed()));
481 connect(&opts->binding(), SIGNAL(config_changed()),
482 this, SLOT(on_config_changed()));
484 // Update sweep timing widgets.
485 update_sample_count_selector();
486 update_sample_rate_selector();
489 void MainBar::commit_sample_rate()
491 uint64_t sample_rate = 0;
493 const shared_ptr<devices::Device> device =
494 device_selector_.selected_device();
498 const shared_ptr<sigrok::Device> sr_dev = device->device();
500 sample_rate = sample_rate_.value();
501 if (sample_rate == 0)
505 sr_dev->config_set(ConfigKey::SAMPLERATE,
506 Glib::Variant<guint64>::create(sample_rate));
507 update_sample_rate_selector();
508 } catch (Error error) {
509 qDebug() << "Failed to configure samplerate.";
513 // Devices with built-in memory might impose limits on certain
514 // configurations, so let's check what sample count the driver
516 update_sample_count_selector();
519 void MainBar::commit_sample_count()
521 uint64_t sample_count = 0;
523 const shared_ptr<devices::Device> device =
524 device_selector_.selected_device();
528 const shared_ptr<sigrok::Device> sr_dev = device->device();
530 sample_count = sample_count_.value();
531 if (sample_count_supported_) {
533 sr_dev->config_set(ConfigKey::LIMIT_SAMPLES,
534 Glib::Variant<guint64>::create(sample_count));
535 update_sample_count_selector();
536 } catch (Error error) {
537 qDebug() << "Failed to configure sample count.";
542 // Devices with built-in memory might impose limits on certain
543 // configurations, so let's check what sample rate the driver
545 update_sample_rate_selector();
548 void MainBar::session_error(const QString text, const QString info_text)
550 QMetaObject::invokeMethod(this, "show_session_error",
551 Qt::QueuedConnection, Q_ARG(QString, text),
552 Q_ARG(QString, info_text));
555 void MainBar::show_session_error(const QString text, const QString info_text)
557 QMessageBox msg(this);
559 msg.setInformativeText(info_text);
560 msg.setStandardButtons(QMessageBox::Ok);
561 msg.setIcon(QMessageBox::Warning);
565 void MainBar::add_decoder(srd_decoder *decoder)
569 session_.add_decoder(decoder);
575 void MainBar::export_file(shared_ptr<OutputFormat> format,
578 using pv::dialogs::StoreProgress;
580 // Stop any currently running capture session
581 session_.stop_capture();
584 const QString dir = settings.value(SettingSaveDirectory).toString();
586 std::pair<uint64_t, uint64_t> sample_range;
588 // Selection only? Verify that the cursors are active and fetch their values
589 if (selection_only) {
590 views::TraceView::View *trace_view =
591 qobject_cast<views::TraceView::View*>(session_.main_view().get());
593 if (!trace_view->cursors()->enabled()) {
594 show_session_error(tr("Missing Cursors"), tr("You need to set the " \
595 "cursors before you can save the data enclosed by them " \
596 "to a session file (e.g. using ALT-V - Show Cursors)."));
600 const double samplerate = session_.get_samplerate();
602 const pv::util::Timestamp& start_time = trace_view->cursors()->first()->time();
603 const pv::util::Timestamp& end_time = trace_view->cursors()->second()->time();
605 const uint64_t start_sample =
606 std::max((double)0, start_time.convert_to<double>() * samplerate);
607 const uint64_t end_sample = end_time.convert_to<double>() * samplerate;
609 sample_range = std::make_pair(start_sample, end_sample);
611 sample_range = std::make_pair(0, 0);
614 // Construct the filter
615 const vector<string> exts = format->extensions();
616 QString filter = tr("%1 files ").arg(
617 QString::fromStdString(format->description()));
622 filter += QString("(*.%1);;%2 (*.*)").arg(
623 QString::fromStdString(join(exts, ", *.")),
626 // Show the file dialog
627 const QString file_name = QFileDialog::getSaveFileName(
628 this, tr("Save File"), dir, filter);
630 if (file_name.isEmpty())
633 const QString abs_path = QFileInfo(file_name).absolutePath();
634 settings.setValue(SettingSaveDirectory, abs_path);
636 // Show the options dialog
637 map<string, Glib::VariantBase> options;
638 if (!format->options().empty()) {
639 dialogs::InputOutputOptions dlg(
640 tr("Export %1").arg(QString::fromStdString(
641 format->description())),
642 format->options(), this);
645 options = dlg.options();
649 session_.set_name(QFileInfo(file_name).fileName());
651 StoreProgress *dlg = new StoreProgress(file_name, format, options,
652 sample_range, session_, this);
656 void MainBar::import_file(shared_ptr<InputFormat> format)
661 const QString dir = settings.value(SettingOpenDirectory).toString();
663 // Construct the filter
664 const vector<string> exts = format->extensions();
665 const QString filter = exts.empty() ? "" :
666 tr("%1 files (*.%2)").arg(
667 QString::fromStdString(format->description()),
668 QString::fromStdString(join(exts, ", *.")));
670 // Show the file dialog
671 const QString file_name = QFileDialog::getOpenFileName(
672 this, tr("Import File"), dir, tr(
673 "%1 files (*.*);;All Files (*.*)").arg(
674 QString::fromStdString(format->description())));
676 if (file_name.isEmpty())
679 // Show the options dialog
680 map<string, Glib::VariantBase> options;
681 if (!format->options().empty()) {
682 dialogs::InputOutputOptions dlg(
683 tr("Import %1").arg(QString::fromStdString(
684 format->description())),
685 format->options(), this);
688 options = dlg.options();
691 session_.load_file(file_name, format, options);
693 const QString abs_path = QFileInfo(file_name).absolutePath();
694 settings.setValue(SettingOpenDirectory, abs_path);
697 void MainBar::on_device_selected()
699 shared_ptr<devices::Device> device = device_selector_.selected_device();
701 reset_device_selector();
705 session_.select_device(device);
708 void MainBar::on_device_changed()
710 update_device_list();
711 update_device_config_widgets();
714 void MainBar::on_capture_state_changed(int state)
716 set_capture_state((pv::Session::capture_state)state);
719 void MainBar::on_sample_count_changed()
721 if (!updating_sample_count_)
722 commit_sample_count();
725 void MainBar::on_sample_rate_changed()
727 if (!updating_sample_rate_)
728 commit_sample_rate();
731 void MainBar::on_config_changed()
733 commit_sample_count();
734 commit_sample_rate();
737 void MainBar::on_actionNewView_triggered()
742 void MainBar::on_actionOpen_triggered()
745 const QString dir = settings.value(SettingOpenDirectory).toString();
748 const QString file_name = QFileDialog::getOpenFileName(
749 this, tr("Open File"), dir, tr(
750 "Sigrok Sessions (*.sr);;"
753 if (!file_name.isEmpty()) {
754 session_.load_file(file_name);
756 const QString abs_path = QFileInfo(file_name).absolutePath();
757 settings.setValue(SettingOpenDirectory, abs_path);
761 void MainBar::on_actionSaveAs_triggered()
763 export_file(session_.device_manager().context()->output_formats()["srzip"]);
766 void MainBar::on_actionSaveSelectionAs_triggered()
768 export_file(session_.device_manager().context()->output_formats()["srzip"], true);
771 void MainBar::on_actionConnect_triggered()
773 // Stop any currently running capture session
774 session_.stop_capture();
776 dialogs::Connect dlg(this, session_.device_manager());
778 // If the user selected a device, select it in the device list. Select the
779 // current device otherwise.
781 session_.select_device(dlg.get_selected_device());
783 update_device_list();
786 void MainBar::add_toolbar_widgets()
788 addAction(action_new_view_);
790 addWidget(open_button_);
791 addWidget(save_button_);
794 StandardBar::add_toolbar_widgets();
796 addWidget(&device_selector_);
797 configure_button_action_ = addWidget(&configure_button_);
798 channels_button_action_ = addWidget(&channels_button_);
799 addWidget(&sample_count_);
800 addWidget(&sample_rate_);
803 addWidget(add_decoder_button_);
807 bool MainBar::eventFilter(QObject *watched, QEvent *event)
809 if (sample_count_supported_ && (watched == &sample_count_ ||
810 watched == &sample_rate_) &&
811 (event->type() == QEvent::ToolTip)) {
812 auto sec = pv::util::Timestamp(sample_count_.value()) / sample_rate_.value();
813 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
815 QString str = tr("Total sampling time: %1").arg(
816 pv::util::format_time_si(sec, pv::util::SIPrefix::unspecified, 0, "s", false));
817 QToolTip::showText(help_event->globalPos(), str);
825 } // namespace toolbars