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