pv/toolbars/mainbar.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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 <assert.h>
  24
  25 #include <QAction>
  26 #include <QDebug>
  27 #include <QHelpEvent>
  28 #include <QMenu>
  29 #include <QToolTip>
  30
  31 #include "mainbar.hpp"
  32
  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>
  38
  39 #include <libsigrok/libsigrok.hpp>
  40
  41 using std::map;
  42 using std::vector;
  43 using std::max;
  44 using std::min;
  45 using std::shared_ptr;
  46 using std::string;
  47
  48 using sigrok::Capability;
  49 using sigrok::ConfigKey;
  50 using sigrok::Device;
  51 using sigrok::Error;
  52
  53 namespace pv {
  54 namespace toolbars {
  55
  56 const uint64_t MainBar::MinSampleCount = 100ULL;
  57 const uint64_t MainBar::MaxSampleCount = 1000000000000ULL;
  58 const uint64_t MainBar::DefaultSampleCount = 1000000;
  59
  60 MainBar::MainBar(Session &session, MainWindow &main_window) :
  61         QToolBar("Sampling Bar", &main_window),
  62         session_(session),
  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),
  78         menu_button_(this)
  79 {
  80         setObjectName(QString::fromUtf8("MainBar"));
  81
  82         setMovable(false);
  83         setFloatable(false);
  84
  85         // Setup the menu
  86         QMenu *const menu = new QMenu(this);
  87
  88         QMenu *const menu_help = new QMenu;
  89         menu_help->setTitle(tr("&Help"));
  90         menu_help->addAction(main_window.action_about());
  91
  92         menu->addAction(menu_help->menuAction());
  93         menu->addSeparator();
  94         menu->addAction(main_window.action_quit());
  95
  96         menu_button_.setMenu(menu);
  97         menu_button_.setPopupMode(QToolButton::InstantPopup);
  98         menu_button_.setIcon(QIcon::fromTheme("menu",
  99                 QIcon(":/icons/menu.svg")));
 100
 101         // Setup the toolbar
 102         addAction(main_window.action_open());
 103         addAction(main_window.action_save_as());
 104         addSeparator();
 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());
 109         addSeparator();
 110         addAction(main_window.action_view_show_cursors());
 111         addSeparator();
 112
 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()));
 121
 122         sample_count_.show_min_max_step(0, UINT64_MAX, 1);
 123
 124         set_capture_state(pv::Session::Stopped);
 125
 126         configure_button_.setIcon(QIcon::fromTheme("configure",
 127                 QIcon(":/icons/configure.png")));
 128
 129         channels_button_.setIcon(QIcon::fromTheme("channels",
 130                 QIcon(":/icons/channels.svg")));
 131
 132         run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 133
 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_);
 140
 141         QWidget *const spacer = new QWidget();
 142         spacer->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 143         addWidget(spacer);
 144
 145         addWidget(&menu_button_);
 146
 147         sample_count_.installEventFilter(this);
 148         sample_rate_.installEventFilter(this);
 149 }
 150
 151 void MainBar::set_device_list(
 152         const std::list< std::shared_ptr<sigrok::Device> > &devices,
 153         shared_ptr<Device> selected)
 154 {
 155         int selected_index = -1;
 156
 157         assert(selected);
 158
 159         updating_device_selector_ = true;
 160
 161         device_selector_.clear();
 162
 163         for (auto device : devices) {
 164                 assert(device);
 165
 166                 string display_name =
 167                         session_.device_manager().get_display_name(device);
 168
 169                 if (selected == device)
 170                         selected_index = device_selector_.count();
 171
 172                 device_selector_.addItem(display_name.c_str(),
 173                         qVariantFromValue(device));
 174         }
 175
 176         // The selected device should have been in the list
 177         assert(selected_index != -1);
 178         device_selector_.setCurrentIndex(selected_index);
 179
 180         update_device_config_widgets();
 181
 182         updating_device_selector_ = false;
 183 }
 184
 185 shared_ptr<Device> MainBar::get_selected_device() const
 186 {
 187         const int index = device_selector_.currentIndex();
 188         if (index < 0)
 189                 return shared_ptr<Device>();
 190
 191         return device_selector_.itemData(index).value<shared_ptr<Device>>();
 192 }
 193
 194 void MainBar::set_capture_state(pv::Session::capture_state state)
 195 {
 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));
 201 }
 202
 203 void MainBar::update_sample_rate_selector()
 204 {
 205         Glib::VariantContainerBase gvar_dict;
 206         GVariant *gvar_list;
 207         const uint64_t *elements = NULL;
 208         gsize num_elements;
 209
 210         if (updating_sample_rate_)
 211                 return;
 212
 213         const shared_ptr<Device> device = get_selected_device();
 214         if (!device)
 215                 return;
 216
 217         assert(!updating_sample_rate_);
 218         updating_sample_rate_ = true;
 219
 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);
 226                 try {
 227                         gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
 228                 } catch(const sigrok::Error &e) {
 229                         // Failed to enunmerate samplerate
 230                         (void)e;
 231                 }
 232         }
 233
 234         if (!gvar_dict) {
 235                 sample_rate_.show_none();
 236                 updating_sample_rate_ = false;
 237                 return;
 238         }
 239
 240         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 241                         "samplerate-steps", G_VARIANT_TYPE("at"))))
 242         {
 243                 elements = (const uint64_t *)g_variant_get_fixed_array(
 244                                 gvar_list, &num_elements, sizeof(uint64_t));
 245
 246                 const uint64_t min = elements[0];
 247                 const uint64_t max = elements[1];
 248                 const uint64_t step = elements[2];
 249
 250                 g_variant_unref(gvar_list);
 251
 252                 assert(min > 0);
 253                 assert(max > 0);
 254                 assert(max > min);
 255                 assert(step > 0);
 256
 257                 if (step == 1)
 258                         sample_rate_.show_125_list(min, max);
 259                 else
 260                 {
 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
 264                         // spin box.
 265                         sample_rate_.show_min_max_step(min, max, step);
 266                 }
 267         }
 268         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 269                         "samplerates", G_VARIANT_TYPE("at"))))
 270         {
 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);
 275         }
 276         updating_sample_rate_ = false;
 277
 278         update_sample_rate_selector_value();
 279 }
 280
 281 void MainBar::update_sample_rate_selector_value()
 282 {
 283         if (updating_sample_rate_)
 284                 return;
 285
 286         const shared_ptr<Device> device = get_selected_device();
 287         if (!device)
 288                 return;
 289
 290         try {
 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";
 300                 return;
 301         }
 302 }
 303
 304 void MainBar::update_sample_count_selector()
 305 {
 306         if (updating_sample_count_)
 307                 return;
 308
 309         const shared_ptr<Device> device = get_selected_device();
 310         if (!device)
 311                 return;
 312
 313         assert(!updating_sample_count_);
 314         updating_sample_count_ = true;
 315
 316         if (!sample_count_supported_)
 317         {
 318                 sample_count_.show_none();
 319                 updating_sample_count_ = false;
 320                 return;
 321         }
 322
 323         uint64_t sample_count = sample_count_.value();
 324         uint64_t min_sample_count = 0;
 325         uint64_t max_sample_count = MaxSampleCount;
 326
 327         if (sample_count == 0)
 328                 sample_count = DefaultSampleCount;
 329
 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()) {
 334                 try {
 335                         auto gvar =
 336                                 device->config_list(ConfigKey::LIMIT_SAMPLES);
 337                         if (gvar)
 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
 342                         (void)e;
 343                 }
 344         }
 345
 346         min_sample_count = min(max(min_sample_count, MinSampleCount),
 347                 max_sample_count);
 348
 349         sample_count_.show_125_list(
 350                 min_sample_count, max_sample_count);
 351
 352         try {
 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),
 358                         max_sample_count);
 359         } catch (Error error) {}
 360
 361         sample_count_.set_value(sample_count);
 362
 363         updating_sample_count_ = false;
 364 }
 365
 366 void MainBar::update_device_config_widgets()
 367 {
 368         using namespace pv::popups;
 369
 370         const shared_ptr<Device> device = get_selected_device();
 371         if (!device)
 372                 return;
 373
 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);
 379
 380         // Update the channels popup
 381         Channels *const channels = new Channels(session_, this);
 382         channels_button_.set_popup(channels);
 383
 384         // Update supported options.
 385         sample_count_supported_ = false;
 386
 387         try {
 388                 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
 389                 {
 390                         auto key = entry.first;
 391                         auto capabilities = entry.second;
 392                         switch (key->id()) {
 393                         case SR_CONF_LIMIT_SAMPLES:
 394                                 if (capabilities.count(Capability::SET))
 395                                         sample_count_supported_ = true;
 396                                 break;
 397                         case SR_CONF_LIMIT_FRAMES:
 398                                 if (capabilities.count(Capability::SET))
 399                                 {
 400                                         device->config_set(ConfigKey::LIMIT_FRAMES,
 401                                                 Glib::Variant<guint64>::create(1));
 402                                         on_config_changed();
 403                                 }
 404                                 break;
 405                         default:
 406                                 break;
 407                         }
 408                 }
 409         } catch (Error error) {}
 410
 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()));
 415
 416         // Update sweep timing widgets.
 417         update_sample_count_selector();
 418         update_sample_rate_selector();
 419 }
 420
 421 void MainBar::commit_sample_count()
 422 {
 423         uint64_t sample_count = 0;
 424
 425         if (updating_sample_count_)
 426                 return;
 427
 428         const shared_ptr<Device> device = get_selected_device();
 429         if (!device)
 430                 return;
 431
 432         sample_count = sample_count_.value();
 433
 434         // Set the sample count
 435         assert(!updating_sample_count_);
 436         updating_sample_count_ = true;
 437         if (sample_count_supported_)
 438         {
 439                 try {
 440                         device->config_set(ConfigKey::LIMIT_SAMPLES,
 441                                 Glib::Variant<guint64>::create(sample_count));
 442                         on_config_changed();
 443                 } catch (Error error) {
 444                         qDebug() << "Failed to configure sample count.";
 445                         return;
 446                 }
 447         }
 448         updating_sample_count_ = false;
 449 }
 450
 451 void MainBar::commit_sample_rate()
 452 {
 453         uint64_t sample_rate = 0;
 454
 455         if (updating_sample_rate_)
 456                 return;
 457
 458         const shared_ptr<Device> device = get_selected_device();
 459         if (!device)
 460                 return;
 461
 462         sample_rate = sample_rate_.value();
 463         if (sample_rate == 0)
 464                 return;
 465
 466         // Set the samplerate
 467         assert(!updating_sample_rate_);
 468         updating_sample_rate_ = true;
 469         try {
 470                 device->config_set(ConfigKey::SAMPLERATE,
 471                         Glib::Variant<guint64>::create(sample_rate));
 472                 on_config_changed();
 473         } catch (Error error) {
 474                 qDebug() << "Failed to configure samplerate.";
 475                 return;
 476         }
 477         updating_sample_rate_ = false;
 478 }
 479
 480 void MainBar::on_device_selected()
 481 {
 482         if (updating_device_selector_)
 483                 return;
 484
 485         shared_ptr<Device> device = get_selected_device();
 486         if (!device)
 487                 return;
 488
 489         main_window_.select_device(device);
 490
 491         update_device_config_widgets();
 492 }
 493
 494 void MainBar::on_sample_count_changed()
 495 {
 496         commit_sample_count();
 497 }
 498
 499 void MainBar::on_sample_rate_changed()
 500 {
 501         commit_sample_rate();
 502 }
 503
 504 void MainBar::on_run_stop()
 505 {
 506         commit_sample_count();
 507         commit_sample_rate();
 508         main_window_.run_stop();
 509 }
 510
 511 void MainBar::on_config_changed()
 512 {
 513         commit_sample_count();
 514         update_sample_count_selector();
 515         commit_sample_rate();
 516         update_sample_rate_selector();
 517 }
 518
 519 bool MainBar::eventFilter(QObject *watched, QEvent *event)
 520 {
 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);
 525
 526                 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
 527                 QToolTip::showText(help_event->globalPos(), str);
 528
 529                 return true;
 530         }
 531
 532         return false;
 533 }
 534
 535 } // namespace toolbars
 536 } // namespace pv