3b1698669a9ac8634a8af1ce87a7786f02cd6833
[pulseview.git] / pv / toolbars / mainbar.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012-2015 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 <algorithm>
24 #include <cassert>
25
26 #include <QAction>
27 #include <QDebug>
28 #include <QHelpEvent>
29 #include <QMenu>
30 #include <QToolTip>
31
32 #include "mainbar.hpp"
33
34 #include <pv/devicemanager.hpp>
35 #include <pv/devices/hardwaredevice.hpp>
36 #include <pv/mainwindow.hpp>
37 #include <pv/popups/deviceoptions.hpp>
38 #include <pv/popups/channels.hpp>
39 #include <pv/util.hpp>
40 #include <pv/widgets/exportmenu.hpp>
41 #include <pv/widgets/importmenu.hpp>
42
43 #include <libsigrokcxx/libsigrokcxx.hpp>
44
45 using std::back_inserter;
46 using std::copy;
47 using std::list;
48 using std::map;
49 using std::max;
50 using std::min;
51 using std::shared_ptr;
52 using std::string;
53 using std::vector;
54
55 using sigrok::Capability;
56 using sigrok::ConfigKey;
57 using sigrok::Error;
58 using sigrok::InputFormat;
59
60 namespace pv {
61 namespace toolbars {
62
63 const uint64_t MainBar::MinSampleCount = 100ULL;
64 const uint64_t MainBar::MaxSampleCount = 1000000000000ULL;
65 const uint64_t MainBar::DefaultSampleCount = 1000000;
66
67 MainBar::MainBar(Session &session, MainWindow &main_window) :
68         QToolBar("Sampling Bar", &main_window),
69         session_(session),
70         main_window_(main_window),
71         device_selector_(this, session.device_manager(),
72                 main_window.action_connect()),
73         configure_button_(this),
74         configure_button_action_(nullptr),
75         channels_button_(this),
76         channels_button_action_(nullptr),
77         sample_count_(" samples", this),
78         sample_rate_("Hz", this),
79         updating_sample_rate_(false),
80         updating_sample_count_(false),
81         sample_count_supported_(false),
82         icon_red_(":/icons/status-red.svg"),
83         icon_green_(":/icons/status-green.svg"),
84         icon_grey_(":/icons/status-grey.svg"),
85         run_stop_button_(this),
86         run_stop_button_action_(nullptr),
87         menu_button_(this)
88 {
89         setObjectName(QString::fromUtf8("MainBar"));
90
91         setMovable(false);
92         setFloatable(false);
93         setContextMenuPolicy(Qt::PreventContextMenu);
94
95         // Open button
96         QToolButton *const open_button = new QToolButton(this);
97
98         widgets::ImportMenu *import_menu = new widgets::ImportMenu(this,
99                 session.device_manager().context(),
100                 main_window.action_open());
101         connect(import_menu,
102                 SIGNAL(format_selected(std::shared_ptr<sigrok::InputFormat>)),
103                 &main_window_,
104                 SLOT(import_file(std::shared_ptr<sigrok::InputFormat>)));
105
106         open_button->setMenu(import_menu);
107         open_button->setDefaultAction(main_window.action_open());
108         open_button->setPopupMode(QToolButton::MenuButtonPopup);
109
110         // Save button
111         QToolButton *const save_button = new QToolButton(this);
112
113         vector<QAction *> open_actions;
114         open_actions.push_back(main_window.action_save_as());
115
116         widgets::ExportMenu *export_menu = new widgets::ExportMenu(this,
117                 session.device_manager().context(),
118                 open_actions);
119         connect(export_menu,
120                 SIGNAL(format_selected(std::shared_ptr<sigrok::OutputFormat>)),
121                 &main_window_,
122                 SLOT(export_file(std::shared_ptr<sigrok::OutputFormat>)));
123
124         save_button->setMenu(export_menu);
125         save_button->setDefaultAction(main_window.action_save_as());
126         save_button->setPopupMode(QToolButton::MenuButtonPopup);
127
128         // Device selector menu
129         connect(&device_selector_, SIGNAL(device_selected()),
130                 this, SLOT(on_device_selected()));
131
132         // Setup the decoder button
133 #ifdef ENABLE_DECODE
134         QToolButton *add_decoder_button = new QToolButton(this);
135         add_decoder_button->setIcon(QIcon::fromTheme("add-decoder",
136                 QIcon(":/icons/add-decoder.svg")));
137         add_decoder_button->setPopupMode(QToolButton::InstantPopup);
138         add_decoder_button->setMenu(main_window_.menu_decoder_add());
139 #endif
140
141         // Setup the burger menu
142         QMenu *const menu = new QMenu(this);
143
144         QMenu *const menu_view = new QMenu;
145         menu_view->setTitle(tr("&View"));
146         menu_view->addAction(main_window.action_view_sticky_scrolling());
147
148         QMenu *const menu_help = new QMenu;
149         menu_help->setTitle(tr("&Help"));
150         menu_help->addAction(main_window.action_about());
151
152         menu->addAction(menu_view->menuAction());
153         menu->addSeparator();
154         menu->addAction(menu_help->menuAction());
155         menu->addSeparator();
156         menu->addAction(main_window.action_quit());
157
158         menu_button_.setMenu(menu);
159         menu_button_.setPopupMode(QToolButton::InstantPopup);
160         menu_button_.setIcon(QIcon::fromTheme("menu",
161                 QIcon(":/icons/menu.svg")));
162
163         // Setup the toolbar
164         addWidget(open_button);
165         addWidget(save_button);
166         addSeparator();
167         addAction(main_window.action_view_zoom_in());
168         addAction(main_window.action_view_zoom_out());
169         addAction(main_window.action_view_zoom_fit());
170         addAction(main_window.action_view_zoom_one_to_one());
171         addSeparator();
172         addAction(main_window.action_view_show_cursors());
173         addSeparator();
174
175         connect(&run_stop_button_, SIGNAL(clicked()),
176                 this, SLOT(on_run_stop()));
177         connect(&sample_count_, SIGNAL(value_changed()),
178                 this, SLOT(on_sample_count_changed()));
179         connect(&sample_rate_, SIGNAL(value_changed()),
180                 this, SLOT(on_sample_rate_changed()));
181
182         sample_count_.show_min_max_step(0, UINT64_MAX, 1);
183
184         set_capture_state(pv::Session::Stopped);
185
186         configure_button_.setIcon(QIcon::fromTheme("configure",
187                 QIcon(":/icons/configure.png")));
188
189         channels_button_.setIcon(QIcon::fromTheme("channels",
190                 QIcon(":/icons/channels.svg")));
191
192         run_stop_button_.setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
193
194         addWidget(&device_selector_);
195         configure_button_action_ = addWidget(&configure_button_);
196         channels_button_action_ = addWidget(&channels_button_);
197         addWidget(&sample_count_);
198         addWidget(&sample_rate_);
199         run_stop_button_action_ = addWidget(&run_stop_button_);
200 #ifdef ENABLE_DECODE
201         addSeparator();
202         addWidget(add_decoder_button);
203 #endif
204
205         QWidget *const spacer = new QWidget();
206         spacer->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
207         addWidget(spacer);
208
209         addWidget(&menu_button_);
210
211         sample_count_.installEventFilter(this);
212         sample_rate_.installEventFilter(this);
213 }
214
215 void MainBar::update_device_list()
216 {
217         DeviceManager &mgr = session_.device_manager();
218         shared_ptr<devices::Device> selected_device = session_.device();
219         list< shared_ptr<devices::Device> > devs;
220
221         copy(mgr.devices().begin(), mgr.devices().end(), back_inserter(devs));
222
223         if (std::find(devs.begin(), devs.end(), selected_device) == devs.end())
224                 devs.push_back(selected_device);
225
226         device_selector_.set_device_list(devs, selected_device);
227         update_device_config_widgets();
228 }
229
230
231 void MainBar::set_capture_state(pv::Session::capture_state state)
232 {
233         const QIcon *icons[] = {&icon_grey_, &icon_red_, &icon_green_};
234         run_stop_button_.setIcon(*icons[state]);
235         run_stop_button_.setText((state == pv::Session::Stopped) ?
236                 tr("Run") : tr("Stop"));
237         run_stop_button_.setShortcut(QKeySequence(Qt::Key_Space));
238
239         bool ui_enabled = (state == pv::Session::Stopped) ? true : false;
240
241         device_selector_.setEnabled(ui_enabled);
242         configure_button_.setEnabled(ui_enabled);
243         channels_button_.setEnabled(ui_enabled);
244         sample_count_.setEnabled(ui_enabled);
245         sample_rate_.setEnabled(ui_enabled);
246 }
247
248 void MainBar::update_sample_rate_selector()
249 {
250         Glib::VariantContainerBase gvar_dict;
251         GVariant *gvar_list;
252         const uint64_t *elements = nullptr;
253         gsize num_elements;
254         map< const ConfigKey*, std::set<Capability> > keys;
255
256         if (updating_sample_rate_) {
257                 sample_rate_.show_none();
258                 return;
259         }
260
261         const shared_ptr<devices::Device> device =
262                 device_selector_.selected_device();
263         if (!device)
264                 return;
265
266         assert(!updating_sample_rate_);
267         updating_sample_rate_ = true;
268
269         const shared_ptr<sigrok::Device> sr_dev = device->device();
270
271         try {
272                 keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
273         } catch (Error) {}
274
275         const auto iter = keys.find(ConfigKey::SAMPLERATE);
276         if (iter != keys.end() &&
277                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
278                 try {
279                         gvar_dict = sr_dev->config_list(ConfigKey::SAMPLERATE);
280                 } catch(const sigrok::Error &e) {
281                         // Failed to enunmerate samplerate
282                         (void)e;
283                 }
284         }
285
286         if (!gvar_dict.gobj()) {
287                 sample_rate_.show_none();
288                 updating_sample_rate_ = false;
289                 return;
290         }
291
292         if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
293                         "samplerate-steps", G_VARIANT_TYPE("at"))))
294         {
295                 elements = (const uint64_t *)g_variant_get_fixed_array(
296                                 gvar_list, &num_elements, sizeof(uint64_t));
297
298                 const uint64_t min = elements[0];
299                 const uint64_t max = elements[1];
300                 const uint64_t step = elements[2];
301
302                 g_variant_unref(gvar_list);
303
304                 assert(min > 0);
305                 assert(max > 0);
306                 assert(max > min);
307                 assert(step > 0);
308
309                 if (step == 1)
310                         sample_rate_.show_125_list(min, max);
311                 else
312                 {
313                         // When the step is not 1, we cam't make a 1-2-5-10
314                         // list of sample rates, because we may not be able to
315                         // make round numbers. Therefore in this case, show a
316                         // spin box.
317                         sample_rate_.show_min_max_step(min, max, step);
318                 }
319         }
320         else if ((gvar_list = g_variant_lookup_value(gvar_dict.gobj(),
321                         "samplerates", G_VARIANT_TYPE("at"))))
322         {
323                 elements = (const uint64_t *)g_variant_get_fixed_array(
324                                 gvar_list, &num_elements, sizeof(uint64_t));
325                 sample_rate_.show_list(elements, num_elements);
326                 g_variant_unref(gvar_list);
327         }
328         updating_sample_rate_ = false;
329
330         update_sample_rate_selector_value();
331 }
332
333 void MainBar::update_sample_rate_selector_value()
334 {
335         if (updating_sample_rate_)
336                 return;
337
338         const shared_ptr<devices::Device> device =
339                 device_selector_.selected_device();
340         if (!device)
341                 return;
342
343         try {
344                 auto gvar = device->device()->config_get(ConfigKey::SAMPLERATE);
345                 uint64_t samplerate =
346                         Glib::VariantBase::cast_dynamic<Glib::Variant<guint64>>(gvar).get();
347                 assert(!updating_sample_rate_);
348                 updating_sample_rate_ = true;
349                 sample_rate_.set_value(samplerate);
350                 updating_sample_rate_ = false;
351         } catch (Error error) {
352                 qDebug() << "WARNING: Failed to get value of sample rate";
353                 return;
354         }
355 }
356
357 void MainBar::update_sample_count_selector()
358 {
359         if (updating_sample_count_)
360                 return;
361
362         const shared_ptr<devices::Device> device =
363                 device_selector_.selected_device();
364         if (!device)
365                 return;
366
367         const shared_ptr<sigrok::Device> sr_dev = device->device();
368
369         assert(!updating_sample_count_);
370         updating_sample_count_ = true;
371
372         if (!sample_count_supported_)
373         {
374                 sample_count_.show_none();
375                 updating_sample_count_ = false;
376                 return;
377         }
378
379         uint64_t sample_count = sample_count_.value();
380         uint64_t min_sample_count = 0;
381         uint64_t max_sample_count = MaxSampleCount;
382
383         if (sample_count == 0)
384                 sample_count = DefaultSampleCount;
385
386         const auto keys = sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS);
387         const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
388         if (iter != keys.end() &&
389                 (*iter).second.find(sigrok::LIST) != (*iter).second.end()) {
390                 try {
391                         auto gvar =
392                                 sr_dev->config_list(ConfigKey::LIMIT_SAMPLES);
393                         if (gvar.gobj())
394                                 g_variant_get(gvar.gobj(), "(tt)",
395                                         &min_sample_count, &max_sample_count);
396                 } catch(const sigrok::Error &e) {
397                         // Failed to query sample limit
398                         (void)e;
399                 }
400         }
401
402         min_sample_count = min(max(min_sample_count, MinSampleCount),
403                 max_sample_count);
404
405         sample_count_.show_125_list(
406                 min_sample_count, max_sample_count);
407
408         try {
409                 auto gvar = sr_dev->config_get(ConfigKey::LIMIT_SAMPLES);
410                 sample_count = g_variant_get_uint64(gvar.gobj());
411                 if (sample_count == 0)
412                         sample_count = DefaultSampleCount;
413                 sample_count = min(max(sample_count, MinSampleCount),
414                         max_sample_count);
415         } catch (Error error) {}
416
417         sample_count_.set_value(sample_count);
418
419         updating_sample_count_ = false;
420 }
421
422 void MainBar::update_device_config_widgets()
423 {
424         using namespace pv::popups;
425
426         const shared_ptr<devices::Device> device =
427                 device_selector_.selected_device();
428
429         // Hide the widgets if no device is selected
430         channels_button_action_->setVisible(!!device);
431         run_stop_button_action_->setVisible(!!device);
432         if (!device) {
433                 configure_button_action_->setVisible(false);
434                 sample_count_.show_none();
435                 sample_rate_.show_none();
436                 return;
437         }
438
439         const shared_ptr<sigrok::Device> sr_dev = device->device();
440         if (!sr_dev)
441                 return;
442
443         // Update the configure popup
444         DeviceOptions *const opts = new DeviceOptions(sr_dev, this);
445         configure_button_action_->setVisible(
446                 !opts->binding().properties().empty());
447         configure_button_.set_popup(opts);
448
449         // Update the channels popup
450         Channels *const channels = new Channels(session_, this);
451         channels_button_.set_popup(channels);
452
453         // Update supported options.
454         sample_count_supported_ = false;
455
456         try {
457                 for (auto entry : sr_dev->config_keys(ConfigKey::DEVICE_OPTIONS))
458                 {
459                         auto key = entry.first;
460                         auto capabilities = entry.second;
461                         switch (key->id()) {
462                         case SR_CONF_LIMIT_SAMPLES:
463                                 if (capabilities.count(Capability::SET))
464                                         sample_count_supported_ = true;
465                                 break;
466                         case SR_CONF_LIMIT_FRAMES:
467                                 if (capabilities.count(Capability::SET))
468                                 {
469                                         sr_dev->config_set(ConfigKey::LIMIT_FRAMES,
470                                                 Glib::Variant<guint64>::create(1));
471                                         on_config_changed();
472                                 }
473                                 break;
474                         default:
475                                 break;
476                         }
477                 }
478         } catch (Error error) {}
479
480         // Add notification of reconfigure events
481         disconnect(this, SLOT(on_config_changed()));
482         connect(&opts->binding(), SIGNAL(config_changed()),
483                 this, SLOT(on_config_changed()));
484
485         // Update sweep timing widgets.
486         update_sample_count_selector();
487         update_sample_rate_selector();
488 }
489
490 void MainBar::commit_sample_count()
491 {
492         uint64_t sample_count = 0;
493
494         const shared_ptr<devices::Device> device =
495                 device_selector_.selected_device();
496         if (!device)
497                 return;
498
499         const shared_ptr<sigrok::Device> sr_dev = device->device();
500
501         sample_count = sample_count_.value();
502         if (sample_count_supported_)
503         {
504                 try {
505                         sr_dev->config_set(ConfigKey::LIMIT_SAMPLES,
506                                 Glib::Variant<guint64>::create(sample_count));
507                         update_sample_count_selector();
508                 } catch (Error error) {
509                         qDebug() << "Failed to configure sample count.";
510                         return;
511                 }
512         }
513
514         // Devices with built-in memory might impose limits on certain
515         // configurations, so let's check what sample rate the driver
516         // lets us use now.
517         update_sample_rate_selector();
518 }
519
520 void MainBar::commit_sample_rate()
521 {
522         uint64_t sample_rate = 0;
523
524         const shared_ptr<devices::Device> device =
525                 device_selector_.selected_device();
526         if (!device)
527                 return;
528
529         const shared_ptr<sigrok::Device> sr_dev = device->device();
530
531         sample_rate = sample_rate_.value();
532         if (sample_rate == 0)
533                 return;
534
535         try {
536                 sr_dev->config_set(ConfigKey::SAMPLERATE,
537                         Glib::Variant<guint64>::create(sample_rate));
538                 update_sample_rate_selector();
539         } catch (Error error) {
540                 qDebug() << "Failed to configure samplerate.";
541                 return;
542         }
543
544         // Devices with built-in memory might impose limits on certain
545         // configurations, so let's check what sample count the driver
546         // lets us use now.
547         update_sample_count_selector();
548 }
549
550 void MainBar::on_device_selected()
551 {
552         shared_ptr<devices::Device> device = device_selector_.selected_device();
553         if (!device)
554                 return;
555
556         main_window_.select_device(device);
557
558         update_device_config_widgets();
559 }
560
561 void MainBar::on_sample_count_changed()
562 {
563         if (!updating_sample_count_)
564                 commit_sample_count();
565 }
566
567 void MainBar::on_sample_rate_changed()
568 {
569         if (!updating_sample_rate_)
570                 commit_sample_rate();
571 }
572
573 void MainBar::on_run_stop()
574 {
575         commit_sample_count();
576         commit_sample_rate();   
577         main_window_.run_stop();
578 }
579
580 void MainBar::on_config_changed()
581 {
582         commit_sample_count();
583         commit_sample_rate();   
584 }
585
586 bool MainBar::eventFilter(QObject *watched, QEvent *event)
587 {
588         if ((watched == &sample_count_ || watched == &sample_rate_) &&
589                 (event->type() == QEvent::ToolTip)) {
590                 auto sec = pv::util::Timestamp(sample_count_.value()) / sample_rate_.value();
591                 QHelpEvent *help_event = static_cast<QHelpEvent*>(event);
592
593                 QString str = tr("Total sampling time: %1").arg(
594                         pv::util::format_time_si(sec, pv::util::SIPrefix::unspecified, 0, "s", false));
595                 QToolTip::showText(help_event->globalPos(), str);
596
597                 return true;
598         }
599
600         return false;
601 }
602
603 } // namespace toolbars
604 } // namespace pv