pv/toolbars/mainbar.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012-2015 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
  21 #include <extdef.h>
  22
  23 #include <algorithm>
  24 #include <cassert>
  25
  26 #include <QAction>
  27 #include <QDebug>
  28 #include <QHelpEvent>
  29 #include <QMenu>
  30 #include <QToolTip>
  31
  32 #include "mainbar.hpp"
  33
  34 #include <pv/devicemanager.hpp>
  35 #include <pv/devices/hardwaredevice.hpp>
  36 #include <pv/mainwindow.hpp>
  37 #include <pv/popups/deviceoptions.hpp>
  38 #include <pv/popups/channels.hpp>
  39 #include <pv/util.hpp>
  40 #include <pv/widgets/exportmenu.hpp>
  41
  42 #include <libsigrokcxx/libsigrokcxx.hpp>
  43
  44 using std::back_inserter;
  45 using std::copy;
  46 using std::list;
  47 using std::map;
  48 using std::max;
  49 using std::min;
  50 using std::shared_ptr;
  51 using std::string;
  52 using std::vector;
  53
  54 using sigrok::Capability;
  55 using sigrok::ConfigKey;
  56 using sigrok::Error;
  57
  58 namespace pv {
  59 namespace toolbars {
  60
  61 const uint64_t MainBar::MinSampleCount = 100ULL;
  62 const uint64_t MainBar::MaxSampleCount = 1000000000000ULL;
  63 const uint64_t MainBar::DefaultSampleCount = 1000000;
  64
  65 MainBar::MainBar(Session &session, MainWindow &main_window) :
  66         QToolBar("Sampling Bar", &main_window),
  67         session_(session),
  68         main_window_(main_window),
  69         device_selector_(this, session.device_manager(),
  70                 main_window.action_connect()),
  71         configure_button_(this),
  72         configure_button_action_(NULL),
  73         channels_button_(this),
  74         sample_count_(" samples", this),
  75         sample_rate_("Hz", this),
  76         updating_sample_rate_(false),
  77         updating_sample_count_(false),
  78         sample_count_supported_(false),
  79         icon_red_(":/icons/status-red.svg"),
  80         icon_green_(":/icons/status-green.svg"),
  81         icon_grey_(":/icons/status-grey.svg"),
  82         run_stop_button_(this),
  83         menu_button_(this)
  84 {
  85         setObjectName(QString::fromUtf8("MainBar"));
  86
  87         setMovable(false);
  88         setFloatable(false);
  89         setContextMenuPolicy(Qt::PreventContextMenu);
  90
  91         // Save button
  92         QToolButton *const save_button = new QToolButton(this);
  93
  94         widgets::ExportMenu *export_menu = new widgets::ExportMenu(this,
  95                 session.device_manager().context(),
  96                 main_window.action_save_as());
  97         connect(export_menu,
  98                 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
  99                 &main_window_,
 100                 SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
 101
 102         save_button->setMenu(export_menu);
 103         save_button->setDefaultAction(main_window.action_save_as());
 104         save_button->setPopupMode(QToolButton::MenuButtonPopup);
 105
 106         // Device selector menu
 107         connect(&device_selector_, SIGNAL(device_selected()),
 108                 this, SLOT(on_device_selected()));
 109
 110         // Setup the decoder button
 111 #ifdef ENABLE_DECODE
 112         QToolButton *add_decoder_button = new QToolButton(this);
 113         add_decoder_button->setIcon(QIcon::fromTheme("add-decoder",
 114                 QIcon(":/icons/add-decoder.svg")));
 115         add_decoder_button->setPopupMode(QToolButton::InstantPopup);
 116         add_decoder_button->setMenu(main_window_.menu_decoder_add());
 117 #endif
 118
 119         // Setup the menu
 120         QMenu *const menu = new QMenu(this);
 121
 122         QMenu *const menu_help = new QMenu;
 123         menu_help->setTitle(tr("&Help"));
 124         menu_help->addAction(main_window.action_about());
 125
 126         menu->addAction(menu_help->menuAction());
 127         menu->addSeparator();
 128         menu->addAction(main_window.action_quit());
 129
 130         menu_button_.setMenu(menu);
 131         menu_button_.setPopupMode(QToolButton::InstantPopup);
 132         menu_button_.setIcon(QIcon::fromTheme("menu",
 133                 QIcon(":/icons/menu.svg")));
 134
 135         // Setup the toolbar
 136         addAction(main_window.action_open());
 137         addWidget(save_button);
 138         addSeparator();
 139         addAction(main_window.action_view_zoom_in());
 140         addAction(main_window.action_view_zoom_out());
 141         addAction(main_window.action_view_zoom_fit());
 142         addAction(main_window.action_view_zoom_one_to_one());
 143         addSeparator();
 144         addAction(main_window.action_view_show_cursors());
 145         addSeparator();
 146
 147         connect(&run_stop_button_, SIGNAL(clicked()),
 148                 this, SLOT(on_run_stop()));
 149         connect(&sample_count_, SIGNAL(value_changed()),
 150                 this, SLOT(on_sample_count_changed()));
 151         connect(&sample_rate_, SIGNAL(value_changed()),
 152                 this, SLOT(on_sample_rate_changed()));
 153
 154         sample_count_.show_min_max_step(0, UINT64_MAX, 1);
 155
 156         set_capture_state(pv::Session::Stopped);
 157
 158         configure_button_.setIcon(QIcon::fromTheme("configure",
 159                 QIcon(":/icons/configure.png")));
 160
 161         channels_button_.setIcon(QIcon::fromTheme("channels",
 162                 QIcon(":/icons/channels.svg")));
 163
 164         run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 165
 166         addWidget(&device_selector_);
 167         configure_button_action_ = addWidget(&configure_button_);
 168         addWidget(&channels_button_);
 169         addWidget(&sample_count_);
 170         addWidget(&sample_rate_);
 171         addWidget(&run_stop_button_);
 172 #ifdef ENABLE_DECODE
 173         addSeparator();
 174         addWidget(add_decoder_button);
 175 #endif
 176
 177         QWidget *const spacer = new QWidget();
 178         spacer->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 179         addWidget(spacer);
 180
 181         addWidget(&menu_button_);
 182
 183         sample_count_.installEventFilter(this);
 184         sample_rate_.installEventFilter(this);
 185 }
 186
 187 void MainBar::update_device_list()
 188 {
 189         DeviceManager &mgr = session_.device_manager();
 190         shared_ptr<devices::Device> selected_device = session_.device();
 191         list< shared_ptr<devices::Device> > devs;
 192
 193         copy(mgr.devices().begin(), mgr.devices().end(), back_inserter(devs));
 194
 195         if (std::find(devs.begin(), devs.end(), selected_device) == devs.end())
 196                 devs.push_back(selected_device);
 197         assert(selected_device);
 198
 199         device_selector_.set_device_list(devs, selected_device);
 200         update_device_config_widgets();
 201 }
 202
 203
 204 void MainBar::set_capture_state(pv::Session::capture_state state)
 205 {
 206         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
 207         run_stop_button_.setIcon(*icons[state]);
 208         run_stop_button_.setText((state == pv::Session::Stopped) ?
 209                 tr("Run") : tr("Stop"));
 210         run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
 211 }
 212
 213 void MainBar::update_sample_rate_selector()
 214 {
 215         Glib::VariantContainerBase gvar_dict;
 216         GVariant *gvar_list;
 217         const uint64_t *elements = NULL;
 218         gsize num_elements;
 219
 220         if (updating_sample_rate_)
 221                 return;
 222
 223         const shared_ptr<devices::Device> device =
 224                 device_selector_.selected_device();
 225         if (!device)
 226                 return;
 227
 228         assert(!updating_sample_rate_);
 229         updating_sample_rate_ = true;
 230
 231         const shared_ptr<sigrok::Device> sr_dev = device->device();
 232         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 233         const auto iter = keys.find(ConfigKey::SAMPLERATE);
 234         if (iter != keys.end() &&
 235                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 236                 try {
 237                         gvar_dict = sr_dev->config_list(ConfigKey::SAMPLERATE);
 238                 } catch(const sigrok::Error &e) {
 239                         // Failed to enunmerate samplerate
 240                         (void)e;
 241                 }
 242         }
 243
 244         if (!gvar_dict.gobj()) {
 245                 sample_rate_.show_none();
 246                 updating_sample_rate_ = false;
 247                 return;
 248         }
 249
 250         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 251                         "samplerate-steps", G_VARIANT_TYPE("at"))))
 252         {
 253                 elements = (const uint64_t *)g_variant_get_fixed_array(
 254                                 gvar_list, &num_elements, sizeof(uint64_t));
 255
 256                 const uint64_t min = elements[0];
 257                 const uint64_t max = elements[1];
 258                 const uint64_t step = elements[2];
 259
 260                 g_variant_unref(gvar_list);
 261
 262                 assert(min > 0);
 263                 assert(max > 0);
 264                 assert(max > min);
 265                 assert(step > 0);
 266
 267                 if (step == 1)
 268                         sample_rate_.show_125_list(min, max);
 269                 else
 270                 {
 271                         // When the step is not 1, we cam't make a 1-2-5-10
 272                         // list of sample rates, because we may not be able to
 273                         // make round numbers. Therefore in this case, show a
 274                         // spin box.
 275                         sample_rate_.show_min_max_step(min, max, step);
 276                 }
 277         }
 278         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 279                         "samplerates", G_VARIANT_TYPE("at"))))
 280         {
 281                 elements = (const uint64_t *)g_variant_get_fixed_array(
 282                                 gvar_list, &num_elements, sizeof(uint64_t));
 283                 sample_rate_.show_list(elements, num_elements);
 284                 g_variant_unref(gvar_list);
 285         }
 286         updating_sample_rate_ = false;
 287
 288         update_sample_rate_selector_value();
 289 }
 290
 291 void MainBar::update_sample_rate_selector_value()
 292 {
 293         if (updating_sample_rate_)
 294                 return;
 295
 296         const shared_ptr<devices::Device> device =
 297                 device_selector_.selected_device();
 298         if (!device)
 299                 return;
 300
 301         try {
 302                 auto gvar = device->device()->config_get(ConfigKey::SAMPLERATE);
 303                 uint64_t samplerate =
 304                         Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
 305                 assert(!updating_sample_rate_);
 306                 updating_sample_rate_ = true;
 307                 sample_rate_.set_value(samplerate);
 308                 updating_sample_rate_ = false;
 309         } catch (Error error) {
 310                 qDebug() << "WARNING: Failed to get value of sample rate";
 311                 return;
 312         }
 313 }
 314
 315 void MainBar::update_sample_count_selector()
 316 {
 317         if (updating_sample_count_)
 318                 return;
 319
 320         const shared_ptr<devices::Device> device =
 321                 device_selector_.selected_device();
 322         if (!device)
 323                 return;
 324
 325         const shared_ptr<sigrok::Device> sr_dev = device->device();
 326
 327         assert(!updating_sample_count_);
 328         updating_sample_count_ = true;
 329
 330         if (!sample_count_supported_)
 331         {
 332                 sample_count_.show_none();
 333                 updating_sample_count_ = false;
 334                 return;
 335         }
 336
 337         uint64_t sample_count = sample_count_.value();
 338         uint64_t min_sample_count = 0;
 339         uint64_t max_sample_count = MaxSampleCount;
 340
 341         if (sample_count == 0)
 342                 sample_count = DefaultSampleCount;
 343
 344         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 345         const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
 346         if (iter != keys.end() &&
 347                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 348                 try {
 349                         auto gvar =
 350                                 sr_dev->config_list(ConfigKey::LIMIT_SAMPLES);
 351                         if (gvar.gobj())
 352                                 g_variant_get(gvar.gobj(), "(tt)",
 353                                         &min_sample_count, &max_sample_count);
 354                 } catch(const sigrok::Error &e) {
 355                         // Failed to query sample limit
 356                         (void)e;
 357                 }
 358         }
 359
 360         min_sample_count = min(max(min_sample_count, MinSampleCount),
 361                 max_sample_count);
 362
 363         sample_count_.show_125_list(
 364                 min_sample_count, max_sample_count);
 365
 366         try {
 367                 auto gvar = sr_dev->config_get(ConfigKey::LIMIT_SAMPLES);
 368                 sample_count = g_variant_get_uint64(gvar.gobj());
 369                 if (sample_count == 0)
 370                         sample_count = DefaultSampleCount;
 371                 sample_count = min(max(sample_count, MinSampleCount),
 372                         max_sample_count);
 373         } catch (Error error) {}
 374
 375         sample_count_.set_value(sample_count);
 376
 377         updating_sample_count_ = false;
 378 }
 379
 380 void MainBar::update_device_config_widgets()
 381 {
 382         using namespace pv::popups;
 383
 384         const shared_ptr<devices::Device> device =
 385                 device_selector_.selected_device();
 386         if (!device)
 387                 return;
 388
 389         const shared_ptr<sigrok::Device> sr_dev = device->device();
 390         if (!sr_dev)
 391                 return;
 392
 393         // Update the configure popup
 394         DeviceOptions *const opts = new DeviceOptions(sr_dev, this);
 395         configure_button_action_->setVisible(
 396                 !opts->binding().properties().empty());
 397         configure_button_.set_popup(opts);
 398
 399         // Update the channels popup
 400         Channels *const channels = new Channels(session_, this);
 401         channels_button_.set_popup(channels);
 402
 403         // Update supported options.
 404         sample_count_supported_ = false;
 405
 406         try {
 407                 for (auto entry : sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS))
 408                 {
 409                         auto key = entry.first;
 410                         auto capabilities = entry.second;
 411                         switch (key->id()) {
 412                         case SR_CONF_LIMIT_SAMPLES:
 413                                 if (capabilities.count(Capability::SET))
 414                                         sample_count_supported_ = true;
 415                                 break;
 416                         case SR_CONF_LIMIT_FRAMES:
 417                                 if (capabilities.count(Capability::SET))
 418                                 {
 419                                         sr_dev->config_set(ConfigKey::LIMIT_FRAMES,
 420                                                 Glib::Variant<guint64>::create(1));
 421                                         on_config_changed();
 422                                 }
 423                                 break;
 424                         default:
 425                                 break;
 426                         }
 427                 }
 428         } catch (Error error) {}
 429
 430         // Add notification of reconfigure events
 431         disconnect(this, SLOT(on_config_changed()));
 432         connect(&opts->binding(), SIGNAL(config_changed()),
 433                 this, SLOT(on_config_changed()));
 434
 435         // Update sweep timing widgets.
 436         update_sample_count_selector();
 437         update_sample_rate_selector();
 438 }
 439
 440 void MainBar::commit_sample_count()
 441 {
 442         uint64_t sample_count = 0;
 443
 444         if (updating_sample_count_)
 445                 return;
 446
 447         const shared_ptr<devices::Device> device =
 448                 device_selector_.selected_device();
 449         if (!device)
 450                 return;
 451
 452         const shared_ptr<sigrok::Device> sr_dev = device->device();
 453
 454         sample_count = sample_count_.value();
 455
 456         // Set the sample count
 457         assert(!updating_sample_count_);
 458         updating_sample_count_ = true;
 459         if (sample_count_supported_)
 460         {
 461                 try {
 462                         sr_dev->config_set(ConfigKey::LIMIT_SAMPLES,
 463                                 Glib::Variant<guint64>::create(sample_count));
 464                         on_config_changed();
 465                 } catch (Error error) {
 466                         qDebug() << "Failed to configure sample count.";
 467                         return;
 468                 }
 469         }
 470         updating_sample_count_ = false;
 471 }
 472
 473 void MainBar::commit_sample_rate()
 474 {
 475         uint64_t sample_rate = 0;
 476
 477         if (updating_sample_rate_)
 478                 return;
 479
 480         const shared_ptr<devices::Device> device =
 481                 device_selector_.selected_device();
 482         if (!device)
 483                 return;
 484
 485         const shared_ptr<sigrok::Device> sr_dev = device->device();
 486
 487         sample_rate = sample_rate_.value();
 488         if (sample_rate == 0)
 489                 return;
 490
 491         // Set the samplerate
 492         assert(!updating_sample_rate_);
 493         updating_sample_rate_ = true;
 494         try {
 495                 sr_dev->config_set(ConfigKey::SAMPLERATE,
 496                         Glib::Variant<guint64>::create(sample_rate));
 497                 on_config_changed();
 498         } catch (Error error) {
 499                 qDebug() << "Failed to configure samplerate.";
 500                 return;
 501         }
 502         updating_sample_rate_ = false;
 503 }
 504
 505 void MainBar::on_device_selected()
 506 {
 507         shared_ptr<devices::Device> device = device_selector_.selected_device();
 508         if (!device)
 509                 return;
 510
 511         main_window_.select_device(device);
 512
 513         update_device_config_widgets();
 514 }
 515
 516 void MainBar::on_sample_count_changed()
 517 {
 518         commit_sample_count();
 519 }
 520
 521 void MainBar::on_sample_rate_changed()
 522 {
 523         commit_sample_rate();
 524 }
 525
 526 void MainBar::on_run_stop()
 527 {
 528         commit_sample_count();
 529         commit_sample_rate();
 530         main_window_.run_stop();
 531 }
 532
 533 void MainBar::on_config_changed()
 534 {
 535         commit_sample_count();
 536         update_sample_count_selector();
 537         commit_sample_rate();
 538         update_sample_rate_selector();
 539 }
 540
 541 bool MainBar::eventFilter(QObject *watched, QEvent *event)
 542 {
 543         if ((watched == &sample_count_ || watched == &sample_rate_) &&
 544                 (event->type() == QEvent::ToolTip)) {
 545                 double sec = (double)sample_count_.value() / sample_rate_.value();
 546                 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
 547
 548                 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
 549                 QToolTip::showText(help_event->globalPos(), str);
 550
 551                 return true;
 552         }
 553
 554         return false;
 555 }
 556
 557 } // namespace toolbars
 558 } // namespace pv