]> sigrok.org Git - pulseview.git/blobdiff - pv/toolbars/samplingbar.cpp
SamplingBar: Handle a failure to list the LIMIT_SAMPLES key
[pulseview.git] / pv / toolbars / samplingbar.cpp
index c35faadad49f5773a179810165bc8b5e8dda4013..710f3128af727cf4ef51ce90178d6efaa94f3ab6 100644 (file)
 
 #include <assert.h>
 
-#include <boost/foreach.hpp>
-
-#include <libsigrok/libsigrok.h>
-
 #include <QAction>
 #include <QDebug>
+#include <QHelpEvent>
+#include <QToolTip>
+
+#include "samplingbar.hpp"
+
+#include <pv/devicemanager.hpp>
+#include <pv/mainwindow.hpp>
+#include <pv/popups/deviceoptions.hpp>
+#include <pv/popups/channels.hpp>
+#include <pv/util.hpp>
 
-#include "samplingbar.h"
+#include <libsigrok/libsigrok.hpp>
 
-#include <pv/dialogs/deviceoptions.h>
+using std::map;
+using std::vector;
+using std::max;
+using std::min;
+using std::shared_ptr;
+using std::string;
+
+using sigrok::Capability;
+using sigrok::ConfigKey;
+using sigrok::Device;
+using sigrok::Error;
 
 namespace pv {
 namespace toolbars {
 
-const uint64_t SamplingBar::RecordLengths[20] = {
-       1000,
-       2500,
-       5000,
-       10000,
-       25000,
-       50000,
-       100000,
-       250000,
-       500000,
-       1000000,
-       2000000,
-       5000000,
-       10000000,
-       25000000,
-       50000000,
-       100000000,
-       250000000,
-       500000000,
-       1000000000,
-       10000000000ULL,
-};
-
-const uint64_t SamplingBar::DefaultRecordLength = 1000000;
-
-SamplingBar::SamplingBar(QWidget *parent) :
-       QToolBar("Sampling Bar", parent),
-       _device_selector(this),
-       _configure_button(this),
-       _record_length_selector(this),
-       _sample_rate_list(this),
-       _icon_green(":/icons/status-green.svg"),
-       _icon_grey(":/icons/status-grey.svg"),
-       _run_stop_button(this)
+const uint64_t SamplingBar::MinSampleCount = 100ULL;
+const uint64_t SamplingBar::MaxSampleCount = 1000000000000ULL;
+const uint64_t SamplingBar::DefaultSampleCount = 1000000;
+
+SamplingBar::SamplingBar(Session &session, MainWindow &main_window) :
+       QToolBar("Sampling Bar", &main_window),
+       session_(session),
+       main_window_(main_window),
+       device_selector_(this),
+       updating_device_selector_(false),
+       configure_button_(this),
+       configure_button_action_(NULL),
+       channels_button_(this),
+       sample_count_(" samples", this),
+       sample_rate_("Hz", this),
+       updating_sample_rate_(false),
+       updating_sample_count_(false),
+       sample_count_supported_(false),
+       icon_red_(":/icons/status-red.svg"),
+       icon_green_(":/icons/status-green.svg"),
+       icon_grey_(":/icons/status-grey.svg"),
+       run_stop_button_(this)
 {
-       connect(&_run_stop_button, SIGNAL(clicked()),
-               this, SIGNAL(run_stop()));
-       connect(&_device_selector, SIGNAL(currentIndexChanged (int)),
+       setObjectName(QString::fromUtf8("SamplingBar"));
+
+       connect(&run_stop_button_, SIGNAL(clicked()),
+               this, SLOT(on_run_stop()));
+       connect(&device_selector_, SIGNAL(currentIndexChanged (int)),
                this, SLOT(on_device_selected()));
-       connect(&_configure_button, SIGNAL(clicked()),
-               this, SLOT(on_configure()));
+       connect(&sample_count_, SIGNAL(value_changed()),
+               this, SLOT(on_sample_count_changed()));
+       connect(&sample_rate_, SIGNAL(value_changed()),
+               this, SLOT(on_sample_rate_changed()));
 
-       _sample_rate_value.setDecimals(0);
-       _sample_rate_value.setSuffix("Hz");
+       sample_count_.show_min_max_step(0, UINT64_MAX, 1);
 
-       for (size_t i = 0; i < countof(RecordLengths); i++)
-       {
-               const uint64_t &l = RecordLengths[i];
-               char *const text = sr_si_string_u64(l, " samples");
-               _record_length_selector.addItem(QString(text),
-                       qVariantFromValue(l));
-               g_free(text);
-
-               if (l == DefaultRecordLength)
-                       _record_length_selector.setCurrentIndex(i);
-       }
-
-       set_sampling(false);
+       set_capture_state(pv::Session::Stopped);
 
-       _configure_button.setIcon(QIcon::fromTheme("configure",
+       configure_button_.setIcon(QIcon::fromTheme("configure",
                QIcon(":/icons/configure.png")));
 
-       _run_stop_button.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
+       channels_button_.setIcon(QIcon::fromTheme("channels",
+               QIcon(":/icons/channels.svg")));
 
-       addWidget(&_device_selector);
-       addWidget(&_configure_button);
-       addWidget(&_record_length_selector);
-       _sample_rate_list_action = addWidget(&_sample_rate_list);
-       _sample_rate_value_action = addWidget(&_sample_rate_value);
-       addWidget(&_run_stop_button);
+       run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 
-       connect(&_sample_rate_list, SIGNAL(currentIndexChanged(int)),
-               this, SLOT(on_sample_rate_changed()));
-       connect(&_sample_rate_value, SIGNAL(editingFinished()),
-               this, SLOT(on_sample_rate_changed()));
+       addWidget(&device_selector_);
+       configure_button_action_ = addWidget(&configure_button_);
+       addWidget(&channels_button_);
+       addWidget(&sample_count_);
+       addWidget(&sample_rate_);
+
+       addWidget(&run_stop_button_);
+
+       sample_count_.installEventFilter(this);
+       sample_rate_.installEventFilter(this);
 }
 
 void SamplingBar::set_device_list(
-       const std::list<struct sr_dev_inst*> &devices)
+       const std::list< std::shared_ptr<sigrok::Device> > &devices,
+       shared_ptr<Device> selected)
 {
-       _device_selector.clear();
-
-       BOOST_FOREACH (sr_dev_inst *sdi, devices) {
-               QString title;
-               if (sdi->vendor && sdi->vendor[0])
-                       title += sdi->vendor + QString(" ");
-               if (sdi->model && sdi->model[0])
-                       title += sdi->model + QString(" ");
-               if (sdi->version && sdi->version[0])
-                       title += sdi->version + QString(" ");
-
-               _device_selector.addItem(title, qVariantFromValue(
-                       (void*)sdi));
-       }
+       int selected_index = -1;
 
-       update_sample_rate_selector();
-}
+       assert(selected);
 
-struct sr_dev_inst* SamplingBar::get_selected_device() const
-{
-       const int index = _device_selector.currentIndex();
-       if (index < 0)
-               return NULL;
+       updating_device_selector_ = true;
 
-       return (sr_dev_inst*)_device_selector.itemData(
-               index).value<void*>();
-}
+       device_selector_.clear();
 
-void SamplingBar::set_selected_device(struct sr_dev_inst *const sdi)
-{
-       for (int i = 0; i < _device_selector.count(); i++)
-               if (sdi == _device_selector.itemData(i).value<void*>()) {
-                       _device_selector.setCurrentIndex(i);
-                       return;
-               }
+       for (auto device : devices) {
+               assert(device);
+
+               string display_name =
+                       session_.device_manager().get_display_name(device);
+
+               if (selected == device)
+                       selected_index = device_selector_.count();
+
+               device_selector_.addItem(display_name.c_str(),
+                       qVariantFromValue(device));
+       }
+
+       // The selected device should have been in the list
+       assert(selected_index != -1);
+       device_selector_.setCurrentIndex(selected_index);
+
+       update_device_config_widgets();
+
+       updating_device_selector_ = false;
 }
 
-uint64_t SamplingBar::get_record_length() const
+shared_ptr<Device> SamplingBar::get_selected_device() const
 {
-       const int index = _record_length_selector.currentIndex();
+       const int index = device_selector_.currentIndex();
        if (index < 0)
-               return 0;
+               return shared_ptr<Device>();
 
-       return _record_length_selector.itemData(index).value<uint64_t>();
+       return device_selector_.itemData(index).value<shared_ptr<Device>>();
 }
 
-void SamplingBar::set_sampling(bool sampling)
+void SamplingBar::set_capture_state(pv::Session::capture_state state)
 {
-       _run_stop_button.setIcon(sampling ? _icon_green : _icon_grey);
-       _run_stop_button.setText(sampling ? "Stop" : "Run");
+       const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
+       run_stop_button_.setIcon(*icons[state]);
+       run_stop_button_.setText((state == pv::Session::Stopped) ?
+               tr("Run") : tr("Stop"));
+       run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
 }
 
 void SamplingBar::update_sample_rate_selector()
 {
-       const sr_dev_inst *const sdi = get_selected_device();
-       GVariant *gvar_dict, *gvar_list;
+       Glib::VariantContainerBase gvar_dict;
+       GVariant *gvar_list;
        const uint64_t *elements = NULL;
        gsize num_elements;
 
-       assert(_sample_rate_value_action);
-       assert(_sample_rate_list_action);
-
-       if (!sdi)
+       if (updating_sample_rate_)
                return;
 
-       if (sr_config_list(sdi->driver, SR_CONF_SAMPLERATE,
-                       &gvar_dict, sdi) != SR_OK)
+       const shared_ptr<Device> device = get_selected_device();
+       if (!device)
                return;
 
-       _sample_rate_list_action->setVisible(false);
-       _sample_rate_value_action->setVisible(false);
+       assert(!updating_sample_rate_);
+       updating_sample_rate_ = true;
+
+       const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
+       const auto iter = keys.find(ConfigKey::SAMPLERATE);
+       if (iter != keys.end() &&
+               (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
+               const auto keys = device->config_keys(
+                       ConfigKey::DEVICE_OPTIONS);
+               try {
+                       gvar_dict = device->config_list(ConfigKey::SAMPLERATE);
+               } catch(const sigrok::Error &e) {
+                       // Failed to enunmerate samplerate
+                       (void)e;
+               }
+       }
+
+       if (!gvar_dict) {
+               sample_rate_.show_none();
+               updating_sample_rate_ = false;
+               return;
+       }
 
-       if ((gvar_list = g_variant_lookup_value(gvar_dict,
-                       "samplerate-steps", G_VARIANT_TYPE("at")))) {
+       if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
+                       "samplerate-steps", G_VARIANT_TYPE("at"))))
+       {
                elements = (const uint64_t *)g_variant_get_fixed_array(
                                gvar_list, &num_elements, sizeof(uint64_t));
-               _sample_rate_value.setRange(elements[0], elements[1]);
-               _sample_rate_value.setSingleStep(elements[2]);
-               _sample_rate_value_action->setVisible(true);
+
+               const uint64_t min = elements[0];
+               const uint64_t max = elements[1];
+               const uint64_t step = elements[2];
+
                g_variant_unref(gvar_list);
+
+               assert(min > 0);
+               assert(max > 0);
+               assert(max > min);
+               assert(step > 0);
+
+               if (step == 1)
+                       sample_rate_.show_125_list(min, max);
+               else
+               {
+                       // When the step is not 1, we cam't make a 1-2-5-10
+                       // list of sample rates, because we may not be able to
+                       // make round numbers. Therefore in this case, show a
+                       // spin box.
+                       sample_rate_.show_min_max_step(min, max, step);
+               }
        }
-       else if ((gvar_list = g_variant_lookup_value(gvar_dict,
+       else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
                        "samplerates", G_VARIANT_TYPE("at"))))
        {
                elements = (const uint64_t *)g_variant_get_fixed_array(
                                gvar_list, &num_elements, sizeof(uint64_t));
-               _sample_rate_list.clear();
-
-               for (unsigned int i = 0; i < num_elements; i++)
-               {
-                       char *const s = sr_samplerate_string(elements[i]);
-                       _sample_rate_list.addItem(QString(s),
-                               qVariantFromValue(elements[i]));
-                       g_free(s);
-               }
-
-               _sample_rate_list.show();
-               _sample_rate_list_action->setVisible(true);
+               sample_rate_.show_list(elements, num_elements);
                g_variant_unref(gvar_list);
        }
+       updating_sample_rate_ = false;
 
-       g_variant_unref(gvar_dict);
        update_sample_rate_selector_value();
 }
 
 void SamplingBar::update_sample_rate_selector_value()
 {
-       sr_dev_inst *const sdi = get_selected_device();
-       GVariant *gvar;
-       uint64_t samplerate;
+       if (updating_sample_rate_)
+               return;
 
-       assert(sdi);
+       const shared_ptr<Device> device = get_selected_device();
+       if (!device)
+               return;
 
-       if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
-               &gvar, sdi) != SR_OK) {
-               qDebug() <<
-                               "WARNING: Failed to get value of sample rate";
+       try {
+               auto gvar = device->config_get(ConfigKey::SAMPLERATE);
+               uint64_t samplerate =
+                       Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
+               assert(!updating_sample_rate_);
+               updating_sample_rate_ = true;
+               sample_rate_.set_value(samplerate);
+               updating_sample_rate_ = false;
+       } catch (Error error) {
+               qDebug() << "WARNING: Failed to get value of sample rate";
                return;
        }
-       samplerate = g_variant_get_uint64(gvar);
-       g_variant_unref(gvar);
+}
+
+void SamplingBar::update_sample_count_selector()
+{
+       if (updating_sample_count_)
+               return;
+
+       const shared_ptr<Device> device = get_selected_device();
+       if (!device)
+               return;
 
-       assert(_sample_rate_value_action);
-       assert(_sample_rate_list_action);
+       assert(!updating_sample_count_);
+       updating_sample_count_ = true;
 
-       if (_sample_rate_value_action->isVisible())
-               _sample_rate_value.setValue(samplerate);
-       else if (_sample_rate_list_action->isVisible())
+       if (!sample_count_supported_)
        {
-               for (int i = 0; i < _sample_rate_list.count(); i++)
-                       if (samplerate == _sample_rate_list.itemData(
-                               i).value<uint64_t>())
-                               _sample_rate_list.setCurrentIndex(i);
+               sample_count_.show_none();
+               updating_sample_count_ = false;
+               return;
        }
+
+       uint64_t sample_count = sample_count_.value();
+       uint64_t min_sample_count = 0;
+       uint64_t max_sample_count = MaxSampleCount;
+
+       if (sample_count == 0)
+               sample_count = DefaultSampleCount;
+
+       const auto keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
+       const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
+       if (iter != keys.end() &&
+               (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
+               try {
+                       auto gvar =
+                               device->config_list(ConfigKey::LIMIT_SAMPLES);
+                       if (gvar)
+                               g_variant_get(gvar.gobj(), "(tt)",
+                                       &min_sample_count, &max_sample_count);
+               } catch(const sigrok::Error &e) {
+                       // Failed to query sample limit
+                       (void)e;
+               }
+       }
+
+       min_sample_count = min(max(min_sample_count, MinSampleCount),
+               max_sample_count);
+
+       sample_count_.show_125_list(
+               min_sample_count, max_sample_count);
+
+       try {
+               auto gvar = device->config_get(ConfigKey::LIMIT_SAMPLES);
+               sample_count = g_variant_get_uint64(gvar.gobj());
+               if (sample_count == 0)
+                       sample_count = DefaultSampleCount;
+               sample_count = min(max(sample_count, MinSampleCount),
+                       max_sample_count);
+       } catch (Error error) {}
+
+       sample_count_.set_value(sample_count);
+
+       updating_sample_count_ = false;
 }
 
-void SamplingBar::commit_sample_rate()
+void SamplingBar::update_device_config_widgets()
 {
-       uint64_t sample_rate = 0;
+       using namespace pv::popups;
 
-       sr_dev_inst *const sdi = get_selected_device();
-       assert(sdi);
+       const shared_ptr<Device> device = get_selected_device();
+       if (!device)
+               return;
+
+       // Update the configure popup
+       DeviceOptions *const opts = new DeviceOptions(device, this);
+       configure_button_action_->setVisible(
+               !opts->binding().properties().empty());
+       configure_button_.set_popup(opts);
+
+       // Update the channels popup
+       Channels *const channels = new Channels(session_, this);
+       channels_button_.set_popup(channels);
+
+       // Update supported options.
+       sample_count_supported_ = false;
+
+       try {
+               for (auto entry : device->config_keys(ConfigKey::DEVICE_OPTIONS))
+               {
+                       auto key = entry.first;
+                       auto capabilities = entry.second;
+                       switch (key->id()) {
+                       case SR_CONF_LIMIT_SAMPLES:
+                               if (capabilities.count(Capability::SET))
+                                       sample_count_supported_ = true;
+                               break;
+                       case SR_CONF_LIMIT_FRAMES:
+                               if (capabilities.count(Capability::SET))
+                               {
+                                       device->config_set(ConfigKey::LIMIT_FRAMES,
+                                               Glib::Variant<guint64>::create(1));
+                                       on_config_changed();
+                               }
+                               break;
+                       default:
+                               break;
+                       }
+               }
+       } catch (Error error) {}
 
-       assert(_sample_rate_value_action);
-       assert(_sample_rate_list_action);
+       // Add notification of reconfigure events
+       disconnect(this, SLOT(on_config_changed()));
+       connect(&opts->binding(), SIGNAL(config_changed()),
+               this, SLOT(on_config_changed()));
 
-       if (_sample_rate_value_action->isVisible())
-               sample_rate = (uint64_t)_sample_rate_value.value();
-       else if (_sample_rate_list_action->isVisible())
+       // Update sweep timing widgets.
+       update_sample_count_selector();
+       update_sample_rate_selector();
+}
+
+void SamplingBar::commit_sample_count()
+{
+       uint64_t sample_count = 0;
+
+       if (updating_sample_count_)
+               return;
+
+       const shared_ptr<Device> device = get_selected_device();
+       if (!device)
+               return;
+
+       sample_count = sample_count_.value();
+
+       // Set the sample count
+       assert(!updating_sample_count_);
+       updating_sample_count_ = true;
+       if (sample_count_supported_)
        {
-               const int index = _sample_rate_list.currentIndex();
-               if (index >= 0)
-                       sample_rate = _sample_rate_list.itemData(
-                               index).value<uint64_t>();
+               try {
+                       device->config_set(ConfigKey::LIMIT_SAMPLES,
+                               Glib::Variant<guint64>::create(sample_count));
+                       on_config_changed();
+               } catch (Error error) {
+                       qDebug() << "Failed to configure sample count.";
+                       return;
+               }
        }
+       updating_sample_count_ = false;
+}
+
+void SamplingBar::commit_sample_rate()
+{
+       uint64_t sample_rate = 0;
+
+       if (updating_sample_rate_)
+               return;
+
+       const shared_ptr<Device> device = get_selected_device();
+       if (!device)
+               return;
+
+       sample_rate = sample_rate_.value();
+       if (sample_rate == 0)
+               return;
 
        // Set the samplerate
-       if (sr_config_set(sdi, SR_CONF_SAMPLERATE,
-               g_variant_new_uint64(sample_rate)) != SR_OK) {
+       assert(!updating_sample_rate_);
+       updating_sample_rate_ = true;
+       try {
+               device->config_set(ConfigKey::SAMPLERATE,
+                       Glib::Variant<guint64>::create(sample_rate));
+               on_config_changed();
+       } catch (Error error) {
                qDebug() << "Failed to configure samplerate.";
                return;
        }
+       updating_sample_rate_ = false;
 }
 
 void SamplingBar::on_device_selected()
 {
-       update_sample_rate_selector();
+       if (updating_device_selector_)
+               return;
+
+       shared_ptr<Device> device = get_selected_device();
+       if (!device)
+               return;
+
+       main_window_.select_device(device);
+
+       update_device_config_widgets();
+}
+
+void SamplingBar::on_sample_count_changed()
+{
+       commit_sample_count();
 }
 
 void SamplingBar::on_sample_rate_changed()
@@ -290,17 +463,35 @@ void SamplingBar::on_sample_rate_changed()
        commit_sample_rate();
 }
 
-void SamplingBar::on_configure()
+void SamplingBar::on_run_stop()
 {
-       commit_sample_rate();
+       commit_sample_count();
+       commit_sample_rate();   
+       main_window_.run_stop();
+}
+
+void SamplingBar::on_config_changed()
+{
+       commit_sample_count();
+       update_sample_count_selector(); 
+       commit_sample_rate();   
+       update_sample_rate_selector();
+}
 
-       sr_dev_inst *const sdi = get_selected_device();
-       assert(sdi);
+bool SamplingBar::eventFilter(QObject *watched, QEvent *event)
+{
+       if ((watched == &sample_count_ || watched == &sample_rate_) &&
+               (event->type() == QEvent::ToolTip)) {
+               double sec = (double)sample_count_.value() / sample_rate_.value();
+               QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
 
-       pv::dialogs::DeviceOptions dlg(this, sdi);
-       dlg.exec();
+               QString str = tr("Total sampling time: %1").arg(pv::util::format_second(sec));
+               QToolTip::showText(help_event->globalPos(), str);
 
-       update_sample_rate_selector_value();
+               return true;
+       }
+
+       return false;
 }
 
 } // namespace toolbars