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         map< const ConfigKey*, std::set<Capability> > keys;
 220
 221         if (updating_sample_rate_)
 222                 return;
 223
 224         const shared_ptr<devices::Device> device =
 225                 device_selector_.selected_device();
 226         if (!device)
 227                 return;
 228
 229         assert(!updating_sample_rate_);
 230         updating_sample_rate_ = true;
 231
 232         const shared_ptr<sigrok::Device> sr_dev = device->device();
 233
 234         try {
 235                 keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 236         } catch (Error) {}
 237
 238         const auto iter = keys.find(ConfigKey::SAMPLERATE);
 239         if (iter != keys.end() &&
 240                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 241                 try {
 242                         gvar_dict = sr_dev->config_list(ConfigKey::SAMPLERATE);
 243                 } catch(const sigrok::Error &e) {
 244                         // Failed to enunmerate samplerate
 245                         (void)e;
 246                 }
 247         }
 248
 249         if (!gvar_dict.gobj()) {
 250                 sample_rate_.show_none();
 251                 updating_sample_rate_ = false;
 252                 return;
 253         }
 254
 255         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 256                         "samplerate-steps", G_VARIANT_TYPE("at"))))
 257         {
 258                 elements = (const uint64_t *)g_variant_get_fixed_array(
 259                                 gvar_list, &num_elements, sizeof(uint64_t));
 260
 261                 const uint64_t min = elements[0];
 262                 const uint64_t max = elements[1];
 263                 const uint64_t step = elements[2];
 264
 265                 g_variant_unref(gvar_list);
 266
 267                 assert(min > 0);
 268                 assert(max > 0);
 269                 assert(max > min);
 270                 assert(step > 0);
 271
 272                 if (step == 1)
 273                         sample_rate_.show_125_list(min, max);
 274                 else
 275                 {
 276                         // When the step is not 1, we cam't make a 1-2-5-10
 277                         // list of sample rates, because we may not be able to
 278                         // make round numbers. Therefore in this case, show a
 279                         // spin box.
 280                         sample_rate_.show_min_max_step(min, max, step);
 281                 }
 282         }
 283         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 284                         "samplerates", G_VARIANT_TYPE("at"))))
 285         {
 286                 elements = (const uint64_t *)g_variant_get_fixed_array(
 287                                 gvar_list, &num_elements, sizeof(uint64_t));
 288                 sample_rate_.show_list(elements, num_elements);
 289                 g_variant_unref(gvar_list);
 290         }
 291         updating_sample_rate_ = false;
 292
 293         update_sample_rate_selector_value();
 294 }
 295
 296 void MainBar::update_sample_rate_selector_value()
 297 {
 298         if (updating_sample_rate_)
 299                 return;
 300
 301         const shared_ptr<devices::Device> device =
 302                 device_selector_.selected_device();
 303         if (!device)
 304                 return;
 305
 306         try {
 307                 auto gvar = device->device()->config_get(ConfigKey::SAMPLERATE);
 308                 uint64_t samplerate =
 309                         Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
 310                 assert(!updating_sample_rate_);
 311                 updating_sample_rate_ = true;
 312                 sample_rate_.set_value(samplerate);
 313                 updating_sample_rate_ = false;
 314         } catch (Error error) {
 315                 qDebug() << "WARNING: Failed to get value of sample rate";
 316                 return;
 317         }
 318 }
 319
 320 void MainBar::update_sample_count_selector()
 321 {
 322         if (updating_sample_count_)
 323                 return;
 324
 325         const shared_ptr<devices::Device> device =
 326                 device_selector_.selected_device();
 327         if (!device)
 328                 return;
 329
 330         const shared_ptr<sigrok::Device> sr_dev = device->device();
 331
 332         assert(!updating_sample_count_);
 333         updating_sample_count_ = true;
 334
 335         if (!sample_count_supported_)
 336         {
 337                 sample_count_.show_none();
 338                 updating_sample_count_ = false;
 339                 return;
 340         }
 341
 342         uint64_t sample_count = sample_count_.value();
 343         uint64_t min_sample_count = 0;
 344         uint64_t max_sample_count = MaxSampleCount;
 345
 346         if (sample_count == 0)
 347                 sample_count = DefaultSampleCount;
 348
 349         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
 350         const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
 351         if (iter != keys.end() &&
 352                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 353                 try {
 354                         auto gvar =
 355                                 sr_dev->config_list(ConfigKey::LIMIT_SAMPLES);
 356                         if (gvar.gobj())
 357                                 g_variant_get(gvar.gobj(), "(tt)",
 358                                         &min_sample_count, &max_sample_count);
 359                 } catch(const sigrok::Error &e) {
 360                         // Failed to query sample limit
 361                         (void)e;
 362                 }
 363         }
 364
 365         min_sample_count = min(max(min_sample_count, MinSampleCount),
 366                 max_sample_count);
 367
 368         sample_count_.show_125_list(
 369                 min_sample_count, max_sample_count);
 370
 371         try {
 372                 auto gvar = sr_dev->config_get(ConfigKey::LIMIT_SAMPLES);
 373                 sample_count = g_variant_get_uint64(gvar.gobj());
 374                 if (sample_count == 0)
 375                         sample_count = DefaultSampleCount;
 376                 sample_count = min(max(sample_count, MinSampleCount),
 377                         max_sample_count);
 378         } catch (Error error) {}
 379
 380         sample_count_.set_value(sample_count);
 381
 382         updating_sample_count_ = false;
 383 }
 384
 385 void MainBar::update_device_config_widgets()
 386 {
 387         using namespace pv::popups;
 388
 389         const shared_ptr<devices::Device> device =
 390                 device_selector_.selected_device();
 391         if (!device)
 392                 return;
 393
 394         const shared_ptr<sigrok::Device> sr_dev = device->device();
 395         if (!sr_dev)
 396                 return;
 397
 398         // Update the configure popup
 399         DeviceOptions *const opts = new DeviceOptions(sr_dev, this);
 400         configure_button_action_->setVisible(
 401                 !opts->binding().properties().empty());
 402         configure_button_.set_popup(opts);
 403
 404         // Update the channels popup
 405         Channels *const channels = new Channels(session_, this);
 406         channels_button_.set_popup(channels);
 407
 408         // Update supported options.
 409         sample_count_supported_ = false;
 410
 411         try {
 412                 for (auto entry : sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS))
 413                 {
 414                         auto key = entry.first;
 415                         auto capabilities = entry.second;
 416                         switch (key->id()) {
 417                         case SR_CONF_LIMIT_SAMPLES:
 418                                 if (capabilities.count(Capability::SET))
 419                                         sample_count_supported_ = true;
 420                                 break;
 421                         case SR_CONF_LIMIT_FRAMES:
 422                                 if (capabilities.count(Capability::SET))
 423                                 {
 424                                         sr_dev->config_set(ConfigKey::LIMIT_FRAMES,
 425                                                 Glib::Variant<guint64>::create(1));
 426                                         on_config_changed();
 427                                 }
 428                                 break;
 429                         default:
 430                                 break;
 431                         }
 432                 }
 433         } catch (Error error) {}
 434
 435         // Add notification of reconfigure events
 436         disconnect(this, SLOT(on_config_changed()));
 437         connect(&opts->binding(), SIGNAL(config_changed()),
 438                 this, SLOT(on_config_changed()));
 439
 440         // Update sweep timing widgets.
 441         update_sample_count_selector();
 442         update_sample_rate_selector();
 443 }
 444
 445 void MainBar::commit_sample_count()
 446 {
 447         uint64_t sample_count = 0;
 448
 449         if (updating_sample_count_)
 450                 return;
 451
 452         const shared_ptr<devices::Device> device =
 453                 device_selector_.selected_device();
 454         if (!device)
 455                 return;
 456
 457         const shared_ptr<sigrok::Device> sr_dev = device->device();
 458
 459         sample_count = sample_count_.value();
 460
 461         // Set the sample count
 462         assert(!updating_sample_count_);
 463         updating_sample_count_ = true;
 464         if (sample_count_supported_)
 465         {
 466                 try {
 467                         sr_dev->config_set(ConfigKey::LIMIT_SAMPLES,
 468                                 Glib::Variant<guint64>::create(sample_count));
 469                         on_config_changed();
 470                 } catch (Error error) {
 471                         qDebug() << "Failed to configure sample count.";
 472                         return;
 473                 }
 474         }
 475         updating_sample_count_ = false;
 476 }
 477
 478 void MainBar::commit_sample_rate()
 479 {
 480         uint64_t sample_rate = 0;
 481
 482         if (updating_sample_rate_)
 483                 return;
 484
 485         const shared_ptr<devices::Device> device =
 486                 device_selector_.selected_device();
 487         if (!device)
 488                 return;
 489
 490         const shared_ptr<sigrok::Device> sr_dev = device->device();
 491
 492         sample_rate = sample_rate_.value();
 493         if (sample_rate == 0)
 494                 return;
 495
 496         // Set the samplerate
 497         assert(!updating_sample_rate_);
 498         updating_sample_rate_ = true;
 499         try {
 500                 sr_dev->config_set(ConfigKey::SAMPLERATE,
 501                         Glib::Variant<guint64>::create(sample_rate));
 502                 on_config_changed();
 503         } catch (Error error) {
 504                 qDebug() << "Failed to configure samplerate.";
 505                 return;
 506         }
 507         updating_sample_rate_ = false;
 508 }
 509
 510 void MainBar::on_device_selected()
 511 {
 512         shared_ptr<devices::Device> device = device_selector_.selected_device();
 513         if (!device)
 514                 return;
 515
 516         main_window_.select_device(device);
 517
 518         update_device_config_widgets();
 519 }
 520
 521 void MainBar::on_sample_count_changed()
 522 {
 523         commit_sample_count();
 524 }
 525
 526 void MainBar::on_sample_rate_changed()
 527 {
 528         commit_sample_rate();
 529 }
 530
 531 void MainBar::on_run_stop()
 532 {
 533         commit_sample_count();
 534         commit_sample_rate();
 535         main_window_.run_stop();
 536 }
 537
 538 void MainBar::on_config_changed()
 539 {
 540         commit_sample_count();
 541         update_sample_count_selector();
 542         commit_sample_rate();
 543         update_sample_rate_selector();
 544 }
 545
 546 bool MainBar::eventFilter(QObject *watched, QEvent *event)
 547 {
 548         if ((watched == &sample_count_ || watched == &sample_rate_) &&
 549                 (event->type() == QEvent::ToolTip)) {
 550                 double sec = (double)sample_count_.value() / sample_rate_.value();
 551                 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
 552
 553                 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
 554                 QToolTip::showText(help_event->globalPos(), str);
 555
 556                 return true;
 557         }
 558
 559         return false;
 560 }
 561
 562 } // namespace toolbars
 563 } // namespace pv