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
 111         connect(&run_stop_button_, SIGNAL(clicked()),
 112                 this, SLOT(on_run_stop()));
 113         connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
 114                 this, SLOT(on_device_selected()));
 115         connect(&sample_count_, SIGNAL(value_changed()),
 116                 this, SLOT(on_sample_count_changed()));
 117         connect(&sample_rate_, SIGNAL(value_changed()),
 118                 this, SLOT(on_sample_rate_changed()));
 119
 120         sample_count_.show_min_max_step(0, UINT64_MAX, 1);
 121
 122         set_capture_state(pv::Session::Stopped);
 123
 124         configure_button_.setIcon(QIcon::fromTheme("configure",
 125                 QIcon(":/icons/configure.png")));
 126
 127         channels_button_.setIcon(QIcon::fromTheme("channels",
 128                 QIcon(":/icons/channels.svg")));
 129
 130         run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 131
 132         addWidget(&device_selector_);
 133         configure_button_action_ = addWidget(&configure_button_);
 134         addWidget(&channels_button_);
 135         addWidget(&sample_count_);
 136         addWidget(&sample_rate_);
 137         addWidget(&run_stop_button_);
 138
 139         QWidget *const spacer = new QWidget();
 140         spacer->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
 141         addWidget(spacer);
 142
 143         addWidget(&menu_button_);
 144
 145         sample_count_.installEventFilter(this);
 146         sample_rate_.installEventFilter(this);
 147 }
 148
 149 void MainBar::set_device_list(
 150         const std::list< std::shared_ptr<sigrok::Device> > &devices,
 151         shared_ptr<Device> selected)
 152 {
 153         int selected_index = -1;
 154
 155         assert(selected);
 156
 157         updating_device_selector_ = true;
 158
 159         device_selector_.clear();
 160
 161         for (auto device : devices) {
 162                 assert(device);
 163
 164                 string display_name =
 165                         session_.device_manager().get_display_name(device);
 166
 167                 if (selected == device)
 168                         selected_index = device_selector_.count();
 169
 170                 device_selector_.addItem(display_name.c_str(),
 171                         qVariantFromValue(device));
 172         }
 173
 174         // The selected device should have been in the list
 175         assert(selected_index != -1);
 176         device_selector_.setCurrentIndex(selected_index);
 177
 178         update_device_config_widgets();
 179
 180         updating_device_selector_ = false;
 181 }
 182
 183 shared_ptr<Device> MainBar::get_selected_device() const
 184 {
 185         const int index = device_selector_.currentIndex();
 186         if (index < 0)
 187                 return shared_ptr<Device>();
 188
 189         return device_selector_.itemData(index).value<shared_ptr<Device>>();
 190 }
 191
 192 void MainBar::set_capture_state(pv::Session::capture_state state)
 193 {
 194         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
 195         run_stop_button_.setIcon(*icons[state]);
 196         run_stop_button_.setText((state == pv::Session::Stopped) ?
 197                 tr("Run") : tr("Stop"));
 198         run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
 199 }
 200
 201 void MainBar::update_sample_rate_selector()
 202 {
 203         Glib::VariantContainerBase gvar_dict;
 204         GVariant *gvar_list;
 205         const uint64_t *elements = NULL;
 206         gsize num_elements;
 207
 208         if (updating_sample_rate_)
 209                 return;
 210
 211         const shared_ptr<Device> device = get_selected_device();
 212         if (!device)
 213                 return;
 214
 215         assert(!updating_sample_rate_);
 216         updating_sample_rate_ = true;
 217
 218         const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
 219         const auto iter = keys.find(ConfigKey::SAMPLERATE);
 220         if (iter != keys.end() &&
 221                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 222                 const auto keys = device->config_keys(
 223                         ConfigKey::DEVICE_OPTIONS);
 224                 try {
 225                         gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
 226                 } catch(const sigrok::Error &e) {
 227                         // Failed to enunmerate samplerate
 228                         (void)e;
 229                 }
 230         }
 231
 232         if (!gvar_dict) {
 233                 sample_rate_.show_none();
 234                 updating_sample_rate_ = false;
 235                 return;
 236         }
 237
 238         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 239                         "samplerate-steps", G_VARIANT_TYPE("at"))))
 240         {
 241                 elements = (const uint64_t *)g_variant_get_fixed_array(
 242                                 gvar_list, &num_elements, sizeof(uint64_t));
 243
 244                 const uint64_t min = elements[0];
 245                 const uint64_t max = elements[1];
 246                 const uint64_t step = elements[2];
 247
 248                 g_variant_unref(gvar_list);
 249
 250                 assert(min > 0);
 251                 assert(max > 0);
 252                 assert(max > min);
 253                 assert(step > 0);
 254
 255                 if (step == 1)
 256                         sample_rate_.show_125_list(min, max);
 257                 else
 258                 {
 259                         // When the step is not 1, we cam't make a 1-2-5-10
 260                         // list of sample rates, because we may not be able to
 261                         // make round numbers. Therefore in this case, show a
 262                         // spin box.
 263                         sample_rate_.show_min_max_step(min, max, step);
 264                 }
 265         }
 266         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 267                         "samplerates", G_VARIANT_TYPE("at"))))
 268         {
 269                 elements = (const uint64_t *)g_variant_get_fixed_array(
 270                                 gvar_list, &num_elements, sizeof(uint64_t));
 271                 sample_rate_.show_list(elements, num_elements);
 272                 g_variant_unref(gvar_list);
 273         }
 274         updating_sample_rate_ = false;
 275
 276         update_sample_rate_selector_value();
 277 }
 278
 279 void MainBar::update_sample_rate_selector_value()
 280 {
 281         if (updating_sample_rate_)
 282                 return;
 283
 284         const shared_ptr<Device> device = get_selected_device();
 285         if (!device)
 286                 return;
 287
 288         try {
 289                 auto gvar = device->config_get(ConfigKey::SAMPLERATE);
 290                 uint64_t samplerate =
 291                         Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
 292                 assert(!updating_sample_rate_);
 293                 updating_sample_rate_ = true;
 294                 sample_rate_.set_value(samplerate);
 295                 updating_sample_rate_ = false;
 296         } catch (Error error) {
 297                 qDebug() << "WARNING: Failed to get value of sample rate";
 298                 return;
 299         }
 300 }
 301
 302 void MainBar::update_sample_count_selector()
 303 {
 304         if (updating_sample_count_)
 305                 return;
 306
 307         const shared_ptr<Device> device = get_selected_device();
 308         if (!device)
 309                 return;
 310
 311         assert(!updating_sample_count_);
 312         updating_sample_count_ = true;
 313
 314         if (!sample_count_supported_)
 315         {
 316                 sample_count_.show_none();
 317                 updating_sample_count_ = false;
 318                 return;
 319         }
 320
 321         uint64_t sample_count = sample_count_.value();
 322         uint64_t min_sample_count = 0;
 323         uint64_t max_sample_count = MaxSampleCount;
 324
 325         if (sample_count == 0)
 326                 sample_count = DefaultSampleCount;
 327
 328         const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
 329         const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
 330         if (iter != keys.end() &&
 331                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 332                 try {
 333                         auto gvar =
 334                                 device->config_list(ConfigKey::LIMIT_SAMPLES);
 335                         if (gvar)
 336                                 g_variant_get(gvar.gobj(), "(tt)",
 337                                         &min_sample_count, &max_sample_count);
 338                 } catch(const sigrok::Error &e) {
 339                         // Failed to query sample limit
 340                         (void)e;
 341                 }
 342         }
 343
 344         min_sample_count = min(max(min_sample_count, MinSampleCount),
 345                 max_sample_count);
 346
 347         sample_count_.show_125_list(
 348                 min_sample_count, max_sample_count);
 349
 350         try {
 351                 auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
 352                 sample_count = g_variant_get_uint64(gvar.gobj());
 353                 if (sample_count == 0)
 354                         sample_count = DefaultSampleCount;
 355                 sample_count = min(max(sample_count, MinSampleCount),
 356                         max_sample_count);
 357         } catch (Error error) {}
 358
 359         sample_count_.set_value(sample_count);
 360
 361         updating_sample_count_ = false;
 362 }
 363
 364 void MainBar::update_device_config_widgets()
 365 {
 366         using namespace pv::popups;
 367
 368         const shared_ptr<Device> device = get_selected_device();
 369         if (!device)
 370                 return;
 371
 372         // Update the configure popup
 373         DeviceOptions *const opts = new DeviceOptions(device, this);
 374         configure_button_action_->setVisible(
 375                 !opts->binding().properties().empty());
 376         configure_button_.set_popup(opts);
 377
 378         // Update the channels popup
 379         Channels *const channels = new Channels(session_, this);
 380         channels_button_.set_popup(channels);
 381
 382         // Update supported options.
 383         sample_count_supported_ = false;
 384
 385         try {
 386                 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
 387                 {
 388                         auto key = entry.first;
 389                         auto capabilities = entry.second;
 390                         switch (key->id()) {
 391                         case SR_CONF_LIMIT_SAMPLES:
 392                                 if (capabilities.count(Capability::SET))
 393                                         sample_count_supported_ = true;
 394                                 break;
 395                         case SR_CONF_LIMIT_FRAMES:
 396                                 if (capabilities.count(Capability::SET))
 397                                 {
 398                                         device->config_set(ConfigKey::LIMIT_FRAMES,
 399                                                 Glib::Variant<guint64>::create(1));
 400                                         on_config_changed();
 401                                 }
 402                                 break;
 403                         default:
 404                                 break;
 405                         }
 406                 }
 407         } catch (Error error) {}
 408
 409         // Add notification of reconfigure events
 410         disconnect(this, SLOT(on_config_changed()));
 411         connect(&opts->binding(), SIGNAL(config_changed()),
 412                 this, SLOT(on_config_changed()));
 413
 414         // Update sweep timing widgets.
 415         update_sample_count_selector();
 416         update_sample_rate_selector();
 417 }
 418
 419 void MainBar::commit_sample_count()
 420 {
 421         uint64_t sample_count = 0;
 422
 423         if (updating_sample_count_)
 424                 return;
 425
 426         const shared_ptr<Device> device = get_selected_device();
 427         if (!device)
 428                 return;
 429
 430         sample_count = sample_count_.value();
 431
 432         // Set the sample count
 433         assert(!updating_sample_count_);
 434         updating_sample_count_ = true;
 435         if (sample_count_supported_)
 436         {
 437                 try {
 438                         device->config_set(ConfigKey::LIMIT_SAMPLES,
 439                                 Glib::Variant<guint64>::create(sample_count));
 440                         on_config_changed();
 441                 } catch (Error error) {
 442                         qDebug() << "Failed to configure sample count.";
 443                         return;
 444                 }
 445         }
 446         updating_sample_count_ = false;
 447 }
 448
 449 void MainBar::commit_sample_rate()
 450 {
 451         uint64_t sample_rate = 0;
 452
 453         if (updating_sample_rate_)
 454                 return;
 455
 456         const shared_ptr<Device> device = get_selected_device();
 457         if (!device)
 458                 return;
 459
 460         sample_rate = sample_rate_.value();
 461         if (sample_rate == 0)
 462                 return;
 463
 464         // Set the samplerate
 465         assert(!updating_sample_rate_);
 466         updating_sample_rate_ = true;
 467         try {
 468                 device->config_set(ConfigKey::SAMPLERATE,
 469                         Glib::Variant<guint64>::create(sample_rate));
 470                 on_config_changed();
 471         } catch (Error error) {
 472                 qDebug() << "Failed to configure samplerate.";
 473                 return;
 474         }
 475         updating_sample_rate_ = false;
 476 }
 477
 478 void MainBar::on_device_selected()
 479 {
 480         if (updating_device_selector_)
 481                 return;
 482
 483         shared_ptr<Device> device = get_selected_device();
 484         if (!device)
 485                 return;
 486
 487         main_window_.select_device(device);
 488
 489         update_device_config_widgets();
 490 }
 491
 492 void MainBar::on_sample_count_changed()
 493 {
 494         commit_sample_count();
 495 }
 496
 497 void MainBar::on_sample_rate_changed()
 498 {
 499         commit_sample_rate();
 500 }
 501
 502 void MainBar::on_run_stop()
 503 {
 504         commit_sample_count();
 505         commit_sample_rate();
 506         main_window_.run_stop();
 507 }
 508
 509 void MainBar::on_config_changed()
 510 {
 511         commit_sample_count();
 512         update_sample_count_selector();
 513         commit_sample_rate();
 514         update_sample_rate_selector();
 515 }
 516
 517 bool MainBar::eventFilter(QObject *watched, QEvent *event)
 518 {
 519         if ((watched == &sample_count_ || watched == &sample_rate_) &&
 520                 (event->type() == QEvent::ToolTip)) {
 521                 double sec = (double)sample_count_.value() / sample_rate_.value();
 522                 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
 523
 524                 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
 525                 QToolTip::showText(help_event->globalPos(), str);
 526
 527                 return true;
 528         }
 529
 530         return false;
 531 }
 532
 533 } // namespace toolbars
 534 } // namespace pv