pv/toolbars/samplingbar.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 <QToolTip>
  29
  30 #include "samplingbar.hpp"
  31
  32 #include <pv/devicemanager.hpp>
  33 #include <pv/popups/deviceoptions.hpp>
  34 #include <pv/popups/channels.hpp>
  35 #include <pv/util.hpp>
  36
  37 #include <libsigrok/libsigrok.hpp>
  38
  39 using std::map;
  40 using std::vector;
  41 using std::max;
  42 using std::min;
  43 using std::shared_ptr;
  44 using std::string;
  45
  46 using sigrok::Capability;
  47 using sigrok::ConfigKey;
  48 using sigrok::Device;
  49 using sigrok::Error;
  50
  51 namespace pv {
  52 namespace toolbars {
  53
  54 const uint64_t SamplingBar::MinSampleCount = 100ULL;
  55 const uint64_t SamplingBar::MaxSampleCount = 1000000000000ULL;
  56 const uint64_t SamplingBar::DefaultSampleCount = 1000000;
  57
  58 SamplingBar::SamplingBar(SigSession &session, QWidget *parent) :
  59         QToolBar("Sampling Bar", parent),
  60         session_(session),
  61         device_selector_(this),
  62         updating_device_selector_(false),
  63         configure_button_(this),
  64         configure_button_action_(NULL),
  65         channels_button_(this),
  66         sample_count_(" samples", this),
  67         sample_rate_("Hz", this),
  68         updating_sample_rate_(false),
  69         updating_sample_count_(false),
  70         sample_count_supported_(false),
  71         icon_red_(":/icons/status-red.svg"),
  72         icon_green_(":/icons/status-green.svg"),
  73         icon_grey_(":/icons/status-grey.svg"),
  74         run_stop_button_(this)
  75 {
  76         setObjectName(QString::fromUtf8("SamplingBar"));
  77
  78         connect(&run_stop_button_, SIGNAL(clicked()),
  79                 this, SLOT(on_run_stop()));
  80         connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
  81                 this, SLOT(on_device_selected()));
  82         connect(&sample_count_, SIGNAL(value_changed()),
  83                 this, SLOT(on_sample_count_changed()));
  84         connect(&sample_rate_, SIGNAL(value_changed()),
  85                 this, SLOT(on_sample_rate_changed()));
  86
  87         sample_count_.show_min_max_step(0, UINT64_MAX, 1);
  88
  89         set_capture_state(pv::SigSession::Stopped);
  90
  91         configure_button_.setIcon(QIcon::fromTheme("configure",
  92                 QIcon(":/icons/configure.png")));
  93
  94         channels_button_.setIcon(QIcon::fromTheme("channels",
  95                 QIcon(":/icons/channels.svg")));
  96
  97         run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
  98
  99         addWidget(&device_selector_);
 100         configure_button_action_ = addWidget(&configure_button_);
 101         addWidget(&channels_button_);
 102         addWidget(&sample_count_);
 103         addWidget(&sample_rate_);
 104
 105         addWidget(&run_stop_button_);
 106
 107         sample_count_.installEventFilter(this);
 108         sample_rate_.installEventFilter(this);
 109 }
 110
 111 void SamplingBar::set_device_list(
 112         const std::list< std::pair<std::shared_ptr<sigrok::Device>, std::string> > &devices,
 113         shared_ptr<Device> selected)
 114 {
 115         int selected_index = -1;
 116
 117         assert(selected);
 118
 119         updating_device_selector_ = true;
 120
 121         device_selector_.clear();
 122
 123         for (auto entry : devices) {
 124                 auto device = entry.first;
 125                 auto display_name = entry.second;
 126
 127                 assert(device);
 128
 129                 if (selected == device)
 130                         selected_index = device_selector_.count();
 131
 132                 device_selector_.addItem(display_name.c_str(),
 133                         qVariantFromValue(device));
 134         }
 135
 136         // The selected device should have been in the list
 137         assert(selected_index != -1);
 138         device_selector_.setCurrentIndex(selected_index);
 139
 140         update_device_config_widgets();
 141
 142         updating_device_selector_ = false;
 143 }
 144
 145 shared_ptr<Device> SamplingBar::get_selected_device() const
 146 {
 147         const int index = device_selector_.currentIndex();
 148         if (index < 0)
 149                 return shared_ptr<Device>();
 150
 151         return device_selector_.itemData(index).value<shared_ptr<Device>>();
 152 }
 153
 154 void SamplingBar::set_capture_state(pv::SigSession::capture_state state)
 155 {
 156         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
 157         run_stop_button_.setIcon(*icons[state]);
 158         run_stop_button_.setText((state == pv::SigSession::Stopped) ?
 159                 tr("Run") : tr("Stop"));
 160         run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
 161 }
 162
 163 void SamplingBar::update_sample_rate_selector()
 164 {
 165         Glib::VariantContainerBase gvar_dict;
 166         GVariant *gvar_list;
 167         const uint64_t *elements = NULL;
 168         gsize num_elements;
 169
 170         if (updating_sample_rate_)
 171                 return;
 172
 173         const shared_ptr<Device> device = get_selected_device();
 174         if (!device)
 175                 return;
 176
 177         assert(!updating_sample_rate_);
 178         updating_sample_rate_ = true;
 179
 180         try {
 181                 gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
 182         } catch (Error error) {
 183                 sample_rate_.show_none();
 184                 updating_sample_rate_ = false;
 185                 return;
 186         }
 187
 188         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 189                         "samplerate-steps", G_VARIANT_TYPE("at"))))
 190         {
 191                 elements = (const uint64_t *)g_variant_get_fixed_array(
 192                                 gvar_list, &num_elements, sizeof(uint64_t));
 193
 194                 const uint64_t min = elements[0];
 195                 const uint64_t max = elements[1];
 196                 const uint64_t step = elements[2];
 197
 198                 g_variant_unref(gvar_list);
 199
 200                 assert(min > 0);
 201                 assert(max > 0);
 202                 assert(max > min);
 203                 assert(step > 0);
 204
 205                 if (step == 1)
 206                         sample_rate_.show_125_list(min, max);
 207                 else
 208                 {
 209                         // When the step is not 1, we cam't make a 1-2-5-10
 210                         // list of sample rates, because we may not be able to
 211                         // make round numbers. Therefore in this case, show a
 212                         // spin box.
 213                         sample_rate_.show_min_max_step(min, max, step);
 214                 }
 215         }
 216         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 217                         "samplerates", G_VARIANT_TYPE("at"))))
 218         {
 219                 elements = (const uint64_t *)g_variant_get_fixed_array(
 220                                 gvar_list, &num_elements, sizeof(uint64_t));
 221                 sample_rate_.show_list(elements, num_elements);
 222                 g_variant_unref(gvar_list);
 223         }
 224         updating_sample_rate_ = false;
 225
 226         update_sample_rate_selector_value();
 227 }
 228
 229 void SamplingBar::update_sample_rate_selector_value()
 230 {
 231         if (updating_sample_rate_)
 232                 return;
 233
 234         const shared_ptr<Device> device = get_selected_device();
 235         if (!device)
 236                 return;
 237
 238         try {
 239                 auto gvar = device->config_get(ConfigKey::SAMPLERATE);
 240                 uint64_t samplerate =
 241                         Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
 242                 assert(!updating_sample_rate_);
 243                 updating_sample_rate_ = true;
 244                 sample_rate_.set_value(samplerate);
 245                 updating_sample_rate_ = false;
 246         } catch (Error error) {
 247                 qDebug() << "WARNING: Failed to get value of sample rate";
 248                 return;
 249         }
 250 }
 251
 252 void SamplingBar::update_sample_count_selector()
 253 {
 254         if (updating_sample_count_)
 255                 return;
 256
 257         const shared_ptr<Device> device = get_selected_device();
 258         if (!device)
 259                 return;
 260
 261         assert(!updating_sample_count_);
 262         updating_sample_count_ = true;
 263
 264         if (!sample_count_supported_)
 265         {
 266                 sample_count_.show_none();
 267                 updating_sample_count_ = false;
 268                 return;
 269         }
 270
 271         uint64_t sample_count = sample_count_.value();
 272         uint64_t min_sample_count = 0;
 273         uint64_t max_sample_count = MaxSampleCount;
 274
 275         if (sample_count == 0)
 276                 sample_count = DefaultSampleCount;
 277
 278         try {
 279                 auto gvar = device->config_list(ConfigKey::LIMIT_SAMPLES);
 280                 g_variant_get(gvar.gobj(), "(tt)",
 281                         &min_sample_count, &max_sample_count);
 282         } catch (Error error) {}
 283
 284         min_sample_count = min(max(min_sample_count, MinSampleCount),
 285                 max_sample_count);
 286
 287         sample_count_.show_125_list(
 288                 min_sample_count, max_sample_count);
 289
 290         try {
 291                 auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
 292                 sample_count = g_variant_get_uint64(gvar.gobj());
 293                 if (sample_count == 0)
 294                         sample_count = DefaultSampleCount;
 295                 sample_count = min(max(sample_count, MinSampleCount),
 296                         max_sample_count);
 297         } catch (Error error) {}
 298
 299         sample_count_.set_value(sample_count);
 300
 301         updating_sample_count_ = false;
 302 }
 303
 304 void SamplingBar::update_device_config_widgets()
 305 {
 306         using namespace pv::popups;
 307
 308         const shared_ptr<Device> device = get_selected_device();
 309         if (!device)
 310                 return;
 311
 312         // Update the configure popup
 313         DeviceOptions *const opts = new DeviceOptions(device, this);
 314         configure_button_action_->setVisible(
 315                 !opts->binding().properties().empty());
 316         configure_button_.set_popup(opts);
 317
 318         // Update the channels popup
 319         Channels *const channels = new Channels(session_, this);
 320         channels_button_.set_popup(channels);
 321
 322         // Update supported options.
 323         sample_count_supported_ = false;
 324
 325         try {
 326                 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
 327                 {
 328                         auto key = entry.first;
 329                         auto capabilities = entry.second;
 330                         switch (key->id()) {
 331                         case SR_CONF_LIMIT_SAMPLES:
 332                                 if (capabilities.count(Capability::SET))
 333                                         sample_count_supported_ = true;
 334                                 break;
 335                         case SR_CONF_LIMIT_FRAMES:
 336                                 if (capabilities.count(Capability::SET))
 337                                 {
 338                                         device->config_set(ConfigKey::LIMIT_FRAMES,
 339                                                 Glib::Variant<guint64>::create(1));
 340                                         on_config_changed();
 341                                 }
 342                                 break;
 343                         default:
 344                                 break;
 345                         }
 346                 }
 347         } catch (Error error) {}
 348
 349         // Add notification of reconfigure events
 350         disconnect(this, SLOT(on_config_changed()));
 351         connect(&opts->binding(), SIGNAL(config_changed()),
 352                 this, SLOT(on_config_changed()));
 353
 354         // Update sweep timing widgets.
 355         update_sample_count_selector();
 356         update_sample_rate_selector();
 357 }
 358
 359 void SamplingBar::commit_sample_count()
 360 {
 361         uint64_t sample_count = 0;
 362
 363         if (updating_sample_count_)
 364                 return;
 365
 366         const shared_ptr<Device> device = get_selected_device();
 367         if (!device)
 368                 return;
 369
 370         sample_count = sample_count_.value();
 371
 372         // Set the sample count
 373         assert(!updating_sample_count_);
 374         updating_sample_count_ = true;
 375         if (sample_count_supported_)
 376         {
 377                 try {
 378                         device->config_set(ConfigKey::LIMIT_SAMPLES,
 379                                 Glib::Variant<guint64>::create(sample_count));
 380                         on_config_changed();
 381                 } catch (Error error) {
 382                         qDebug() << "Failed to configure sample count.";
 383                         return;
 384                 }
 385         }
 386         updating_sample_count_ = false;
 387 }
 388
 389 void SamplingBar::commit_sample_rate()
 390 {
 391         uint64_t sample_rate = 0;
 392
 393         if (updating_sample_rate_)
 394                 return;
 395
 396         const shared_ptr<Device> device = get_selected_device();
 397         if (!device)
 398                 return;
 399
 400         sample_rate = sample_rate_.value();
 401         if (sample_rate == 0)
 402                 return;
 403
 404         // Set the samplerate
 405         assert(!updating_sample_rate_);
 406         updating_sample_rate_ = true;
 407         try {
 408                 device->config_set(ConfigKey::SAMPLERATE,
 409                         Glib::Variant<guint64>::create(sample_rate));
 410                 on_config_changed();
 411         } catch (Error error) {
 412                 qDebug() << "Failed to configure samplerate.";
 413                 return;
 414         }
 415         updating_sample_rate_ = false;
 416 }
 417
 418 void SamplingBar::on_device_selected()
 419 {
 420         if (updating_device_selector_)
 421                 return;
 422
 423         shared_ptr<Device> device = get_selected_device();
 424         if (!device)
 425                 return;
 426
 427         session_.set_device(device);
 428
 429         update_device_config_widgets();
 430 }
 431
 432 void SamplingBar::on_sample_count_changed()
 433 {
 434         commit_sample_count();
 435 }
 436
 437 void SamplingBar::on_sample_rate_changed()
 438 {
 439         commit_sample_rate();
 440 }
 441
 442 void SamplingBar::on_run_stop()
 443 {
 444         commit_sample_count();
 445         commit_sample_rate();
 446         run_stop();
 447 }
 448
 449 void SamplingBar::on_config_changed()
 450 {
 451         commit_sample_count();
 452         update_sample_count_selector();
 453         commit_sample_rate();
 454         update_sample_rate_selector();
 455 }
 456
 457 bool SamplingBar::eventFilter(QObject *watched, QEvent *event)
 458 {
 459         if ((watched == &sample_count_ || watched == &sample_rate_) &&
 460                 (event->type() == QEvent::ToolTip)) {
 461                 double sec = (double)sample_count_.value() / sample_rate_.value();
 462                 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
 463
 464                 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
 465                 QToolTip::showText(help_event->globalPos(), str);
 466
 467                 return true;
 468         }
 469
 470         return false;
 471 }
 472
 473 } // namespace toolbars
 474 } // namespace pv