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         const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
 181         const auto iter = keys.find(ConfigKey::SAMPLERATE);
 182         if (iter != keys.end() &&
 183                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 184                 gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
 185         } else {
 186                 sample_rate_.show_none();
 187                 updating_sample_rate_ = false;
 188                 return;
 189         }
 190
 191         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 192                         "samplerate-steps", G_VARIANT_TYPE("at"))))
 193         {
 194                 elements = (const uint64_t *)g_variant_get_fixed_array(
 195                                 gvar_list, &num_elements, sizeof(uint64_t));
 196
 197                 const uint64_t min = elements[0];
 198                 const uint64_t max = elements[1];
 199                 const uint64_t step = elements[2];
 200
 201                 g_variant_unref(gvar_list);
 202
 203                 assert(min > 0);
 204                 assert(max > 0);
 205                 assert(max > min);
 206                 assert(step > 0);
 207
 208                 if (step == 1)
 209                         sample_rate_.show_125_list(min, max);
 210                 else
 211                 {
 212                         // When the step is not 1, we cam't make a 1-2-5-10
 213                         // list of sample rates, because we may not be able to
 214                         // make round numbers. Therefore in this case, show a
 215                         // spin box.
 216                         sample_rate_.show_min_max_step(min, max, step);
 217                 }
 218         }
 219         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
 220                         "samplerates", G_VARIANT_TYPE("at"))))
 221         {
 222                 elements = (const uint64_t *)g_variant_get_fixed_array(
 223                                 gvar_list, &num_elements, sizeof(uint64_t));
 224                 sample_rate_.show_list(elements, num_elements);
 225                 g_variant_unref(gvar_list);
 226         }
 227         updating_sample_rate_ = false;
 228
 229         update_sample_rate_selector_value();
 230 }
 231
 232 void SamplingBar::update_sample_rate_selector_value()
 233 {
 234         if (updating_sample_rate_)
 235                 return;
 236
 237         const shared_ptr<Device> device = get_selected_device();
 238         if (!device)
 239                 return;
 240
 241         try {
 242                 auto gvar = device->config_get(ConfigKey::SAMPLERATE);
 243                 uint64_t samplerate =
 244                         Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
 245                 assert(!updating_sample_rate_);
 246                 updating_sample_rate_ = true;
 247                 sample_rate_.set_value(samplerate);
 248                 updating_sample_rate_ = false;
 249         } catch (Error error) {
 250                 qDebug() << "WARNING: Failed to get value of sample rate";
 251                 return;
 252         }
 253 }
 254
 255 void SamplingBar::update_sample_count_selector()
 256 {
 257         if (updating_sample_count_)
 258                 return;
 259
 260         const shared_ptr<Device> device = get_selected_device();
 261         if (!device)
 262                 return;
 263
 264         assert(!updating_sample_count_);
 265         updating_sample_count_ = true;
 266
 267         if (!sample_count_supported_)
 268         {
 269                 sample_count_.show_none();
 270                 updating_sample_count_ = false;
 271                 return;
 272         }
 273
 274         uint64_t sample_count = sample_count_.value();
 275         uint64_t min_sample_count = 0;
 276         uint64_t max_sample_count = MaxSampleCount;
 277
 278         if (sample_count == 0)
 279                 sample_count = DefaultSampleCount;
 280
 281         const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
 282         const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
 283         if (iter != keys.end() &&
 284                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
 285                 auto gvar = device->config_list(ConfigKey::LIMIT_SAMPLES);
 286                 g_variant_get(gvar.gobj(), "(tt)",
 287                         &min_sample_count, &max_sample_count);
 288         }
 289
 290         min_sample_count = min(max(min_sample_count, MinSampleCount),
 291                 max_sample_count);
 292
 293         sample_count_.show_125_list(
 294                 min_sample_count, max_sample_count);
 295
 296         try {
 297                 auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
 298                 sample_count = g_variant_get_uint64(gvar.gobj());
 299                 if (sample_count == 0)
 300                         sample_count = DefaultSampleCount;
 301                 sample_count = min(max(sample_count, MinSampleCount),
 302                         max_sample_count);
 303         } catch (Error error) {}
 304
 305         sample_count_.set_value(sample_count);
 306
 307         updating_sample_count_ = false;
 308 }
 309
 310 void SamplingBar::update_device_config_widgets()
 311 {
 312         using namespace pv::popups;
 313
 314         const shared_ptr<Device> device = get_selected_device();
 315         if (!device)
 316                 return;
 317
 318         // Update the configure popup
 319         DeviceOptions *const opts = new DeviceOptions(device, this);
 320         configure_button_action_->setVisible(
 321                 !opts->binding().properties().empty());
 322         configure_button_.set_popup(opts);
 323
 324         // Update the channels popup
 325         Channels *const channels = new Channels(session_, this);
 326         channels_button_.set_popup(channels);
 327
 328         // Update supported options.
 329         sample_count_supported_ = false;
 330
 331         try {
 332                 for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
 333                 {
 334                         auto key = entry.first;
 335                         auto capabilities = entry.second;
 336                         switch (key->id()) {
 337                         case SR_CONF_LIMIT_SAMPLES:
 338                                 if (capabilities.count(Capability::SET))
 339                                         sample_count_supported_ = true;
 340                                 break;
 341                         case SR_CONF_LIMIT_FRAMES:
 342                                 if (capabilities.count(Capability::SET))
 343                                 {
 344                                         device->config_set(ConfigKey::LIMIT_FRAMES,
 345                                                 Glib::Variant<guint64>::create(1));
 346                                         on_config_changed();
 347                                 }
 348                                 break;
 349                         default:
 350                                 break;
 351                         }
 352                 }
 353         } catch (Error error) {}
 354
 355         // Add notification of reconfigure events
 356         disconnect(this, SLOT(on_config_changed()));
 357         connect(&opts->binding(), SIGNAL(config_changed()),
 358                 this, SLOT(on_config_changed()));
 359
 360         // Update sweep timing widgets.
 361         update_sample_count_selector();
 362         update_sample_rate_selector();
 363 }
 364
 365 void SamplingBar::commit_sample_count()
 366 {
 367         uint64_t sample_count = 0;
 368
 369         if (updating_sample_count_)
 370                 return;
 371
 372         const shared_ptr<Device> device = get_selected_device();
 373         if (!device)
 374                 return;
 375
 376         sample_count = sample_count_.value();
 377
 378         // Set the sample count
 379         assert(!updating_sample_count_);
 380         updating_sample_count_ = true;
 381         if (sample_count_supported_)
 382         {
 383                 try {
 384                         device->config_set(ConfigKey::LIMIT_SAMPLES,
 385                                 Glib::Variant<guint64>::create(sample_count));
 386                         on_config_changed();
 387                 } catch (Error error) {
 388                         qDebug() << "Failed to configure sample count.";
 389                         return;
 390                 }
 391         }
 392         updating_sample_count_ = false;
 393 }
 394
 395 void SamplingBar::commit_sample_rate()
 396 {
 397         uint64_t sample_rate = 0;
 398
 399         if (updating_sample_rate_)
 400                 return;
 401
 402         const shared_ptr<Device> device = get_selected_device();
 403         if (!device)
 404                 return;
 405
 406         sample_rate = sample_rate_.value();
 407         if (sample_rate == 0)
 408                 return;
 409
 410         // Set the samplerate
 411         assert(!updating_sample_rate_);
 412         updating_sample_rate_ = true;
 413         try {
 414                 device->config_set(ConfigKey::SAMPLERATE,
 415                         Glib::Variant<guint64>::create(sample_rate));
 416                 on_config_changed();
 417         } catch (Error error) {
 418                 qDebug() << "Failed to configure samplerate.";
 419                 return;
 420         }
 421         updating_sample_rate_ = false;
 422 }
 423
 424 void SamplingBar::on_device_selected()
 425 {
 426         if (updating_device_selector_)
 427                 return;
 428
 429         shared_ptr<Device> device = get_selected_device();
 430         if (!device)
 431                 return;
 432
 433         session_.set_device(device);
 434
 435         update_device_config_widgets();
 436 }
 437
 438 void SamplingBar::on_sample_count_changed()
 439 {
 440         commit_sample_count();
 441 }
 442
 443 void SamplingBar::on_sample_rate_changed()
 444 {
 445         commit_sample_rate();
 446 }
 447
 448 void SamplingBar::on_run_stop()
 449 {
 450         commit_sample_count();
 451         commit_sample_rate();
 452         run_stop();
 453 }
 454
 455 void SamplingBar::on_config_changed()
 456 {
 457         commit_sample_count();
 458         update_sample_count_selector();
 459         commit_sample_rate();
 460         update_sample_rate_selector();
 461 }
 462
 463 bool SamplingBar::eventFilter(QObject *watched, QEvent *event)
 464 {
 465         if ((watched == &sample_count_ || watched == &sample_rate_) &&
 466                 (event->type() == QEvent::ToolTip)) {
 467                 double sec = (double)sample_count_.value() / sample_rate_.value();
 468                 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
 469
 470                 QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
 471                 QToolTip::showText(help_event->globalPos(), str);
 472
 473                 return true;
 474         }
 475
 476         return false;
 477 }
 478
 479 } // namespace toolbars
 480 } // namespace pv