2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
22 #include <libsigrokdecode/libsigrokdecode.h>
33 #include <unordered_set>
35 #include <QApplication>
37 #include <QFontMetrics>
38 #include <QMouseEvent>
41 #include <libsigrokcxx/libsigrokcxx.hpp>
43 #include "decodetrace.hpp"
45 #include "logicsignal.hpp"
48 #include "tracegroup.hpp"
50 #include "viewport.hpp"
52 #include "pv/session.hpp"
53 #include "pv/devices/device.hpp"
54 #include "pv/data/logic.hpp"
55 #include "pv/data/logicsegment.hpp"
56 #include "pv/util.hpp"
58 using boost::shared_lock;
59 using boost::shared_mutex;
61 using pv::data::SignalData;
62 using pv::data::Segment;
63 using pv::util::format_time;
66 using std::dynamic_pointer_cast;
69 using std::lock_guard;
75 using std::set_difference;
76 using std::shared_ptr;
77 using std::unordered_map;
78 using std::unordered_set;
85 const double View::MaxScale = 1e9;
86 const double View::MinScale = 1e-15;
88 const int View::MaxScrollValue = INT_MAX / 2;
89 const int View::MaxViewAutoUpdateRate = 25; // No more than 25 Hz with sticky scrolling
91 const int View::ScaleUnits[3] = {1, 2, 5};
93 View::View(Session &session, QWidget *parent) :
94 QAbstractScrollArea(parent),
96 viewport_(new Viewport(*this)),
97 ruler_(new Ruler(*this)),
98 header_(new Header(*this)),
101 updating_scroll_(false),
102 sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
103 always_zoom_to_fit_(false),
106 show_cursors_(false),
107 cursors_(new CursorPair(*this)),
108 next_flag_text_('A'),
111 connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
112 this, SLOT(h_scroll_value_changed(int)));
113 connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
114 this, SLOT(v_scroll_value_changed()));
116 connect(&session_, SIGNAL(signals_changed()),
117 this, SLOT(signals_changed()));
118 connect(&session_, SIGNAL(capture_state_changed(int)),
119 this, SLOT(data_updated()));
120 connect(&session_, SIGNAL(data_received()),
121 this, SLOT(data_updated()));
122 connect(&session_, SIGNAL(frame_ended()),
123 this, SLOT(data_updated()));
125 connect(header_, SIGNAL(selection_changed()),
126 ruler_, SLOT(clear_selection()));
127 connect(ruler_, SIGNAL(selection_changed()),
128 header_, SLOT(clear_selection()));
130 connect(header_, SIGNAL(selection_changed()),
131 this, SIGNAL(selection_changed()));
132 connect(ruler_, SIGNAL(selection_changed()),
133 this, SIGNAL(selection_changed()));
135 connect(this, SIGNAL(hover_point_changed()),
136 this, SLOT(on_hover_point_changed()));
138 connect(&lazy_event_handler_, SIGNAL(timeout()),
139 this, SLOT(process_sticky_events()));
140 lazy_event_handler_.setSingleShot(true);
142 connect(&delayed_view_updater_, SIGNAL(timeout()),
143 this, SLOT(perform_delayed_view_update()));
144 delayed_view_updater_.setSingleShot(true);
145 delayed_view_updater_.setInterval(1000 / MaxViewAutoUpdateRate);
147 setViewport(viewport_);
149 viewport_->installEventFilter(this);
150 ruler_->installEventFilter(this);
151 header_->installEventFilter(this);
153 // Trigger the initial event manually. The default device has signals
154 // which were created before this object came into being
157 // make sure the transparent widgets are on the top
161 // Update the zoom state
162 calculate_tick_spacing();
165 Session& View::session()
170 const Session& View::session() const
180 const View* View::view() const
185 Viewport* View::viewport()
190 const Viewport* View::viewport() const
195 vector< shared_ptr<TimeItem> > View::time_items() const
197 const vector<shared_ptr<Flag>> f(flags());
198 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
199 items.push_back(cursors_);
200 items.push_back(cursors_->first());
201 items.push_back(cursors_->second());
205 double View::scale() const
210 double View::offset() const
215 int View::owner_visual_v_offset() const
217 return -verticalScrollBar()->sliderPosition();
220 void View::set_v_offset(int offset)
222 verticalScrollBar()->setSliderPosition(offset);
227 unsigned int View::depth() const
232 unsigned int View::tick_prefix() const
237 double View::tick_period() const
242 void View::zoom(double steps)
244 zoom(steps, viewport_->width() / 2);
247 void View::zoom(double steps, int offset)
249 set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
252 void View::zoom_fit(bool gui_state)
254 // Act as one-shot when stopped, toggle along with the GUI otherwise
255 if (session_.get_capture_state() == Session::Stopped) {
256 always_zoom_to_fit_ = false;
257 always_zoom_to_fit_changed(false);
259 always_zoom_to_fit_ = gui_state;
260 always_zoom_to_fit_changed(gui_state);
263 const pair<double, double> extents = get_time_extents();
264 const double delta = extents.second - extents.first;
269 const int w = viewport_->width();
273 const double scale = max(min(delta / w, MaxScale), MinScale);
274 set_scale_offset(scale, extents.first);
277 void View::zoom_one_to_one()
279 using pv::data::SignalData;
281 // Make a set of all the visible data objects
282 set< shared_ptr<SignalData> > visible_data = get_visible_data();
283 if (visible_data.empty())
286 double samplerate = 0.0;
287 for (const shared_ptr<SignalData> d : visible_data) {
289 const vector< shared_ptr<Segment> > segments =
291 for (const shared_ptr<Segment> &s : segments)
292 samplerate = max(samplerate, s->samplerate());
295 if (samplerate == 0.0)
299 const int w = viewport_->width();
303 set_zoom(1.0 / samplerate, w / 2);
306 void View::set_scale_offset(double scale, double offset)
308 // Disable sticky scrolling / always zoom to fit when acquisition runs
309 // and user drags the viewport
310 if ((scale_ == scale) && (offset_ != offset) &&
311 (session_.get_capture_state() == Session::Running)) {
313 if (sticky_scrolling_) {
314 sticky_scrolling_ = false;
315 sticky_scrolling_changed(false);
318 if (always_zoom_to_fit_) {
319 always_zoom_to_fit_ = false;
320 always_zoom_to_fit_changed(false);
327 calculate_tick_spacing();
332 scale_offset_changed();
335 set< shared_ptr<SignalData> > View::get_visible_data() const
337 shared_lock<shared_mutex> lock(session().signals_mutex());
338 const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
340 // Make a set of all the visible data objects
341 set< shared_ptr<SignalData> > visible_data;
342 for (const shared_ptr<Signal> sig : sigs)
344 visible_data.insert(sig->data());
349 pair<double, double> View::get_time_extents() const
351 double left_time = DBL_MAX, right_time = DBL_MIN;
352 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
353 for (const shared_ptr<SignalData> d : visible_data)
355 const vector< shared_ptr<Segment> > segments =
357 for (const shared_ptr<Segment> &s : segments) {
358 double samplerate = s->samplerate();
359 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
361 const double start_time = s->start_time();
362 left_time = min(left_time, start_time);
363 right_time = max(right_time, start_time +
364 d->max_sample_count() / samplerate);
368 if (left_time == DBL_MAX && right_time == DBL_MIN)
369 return make_pair(0.0, 0.0);
371 assert(left_time < right_time);
372 return make_pair(left_time, right_time);
375 void View::enable_sticky_scrolling(bool state)
377 sticky_scrolling_ = state;
380 bool View::cursors_shown() const
382 return show_cursors_;
385 void View::show_cursors(bool show)
387 show_cursors_ = show;
392 void View::centre_cursors()
394 const double time_width = scale_ * viewport_->width();
395 cursors_->first()->set_time(offset_ + time_width * 0.4);
396 cursors_->second()->set_time(offset_ + time_width * 0.6);
401 std::shared_ptr<CursorPair> View::cursors() const
406 void View::add_flag(double time)
408 flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
409 QString("%1").arg(next_flag_text_))));
410 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
411 (next_flag_text_ + 1);
412 time_item_appearance_changed(true, true);
415 void View::remove_flag(std::shared_ptr<Flag> flag)
418 time_item_appearance_changed(true, true);
421 vector< std::shared_ptr<Flag> > View::flags() const
423 vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
424 stable_sort(flags.begin(), flags.end(),
425 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
426 return a->time() < b->time();
432 const QPoint& View::hover_point() const
437 void View::update_viewport()
444 void View::restack_all_row_items()
446 // Make a list of owners that is sorted from deepest first
447 const auto owners = list_row_item_owners();
448 vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
449 sort(sorted_owners.begin(), sorted_owners.end(),
450 [](const RowItemOwner* a, const RowItemOwner *b) {
451 return a->depth() > b->depth(); });
453 // Restack the items recursively
454 for (auto &o : sorted_owners)
457 // Animate the items to their destination
458 for (const auto &r : *this)
459 r->animate_to_layout_v_offset();
462 void View::get_scroll_layout(double &length, double &offset) const
464 const pair<double, double> extents = get_time_extents();
465 length = (extents.second - extents.first) / scale_;
466 offset = offset_ / scale_;
469 void View::set_zoom(double scale, int offset)
471 // Reset the "always zoom to fit" feature as the user changed the zoom
472 always_zoom_to_fit_ = false;
473 always_zoom_to_fit_changed(false);
475 const double cursor_offset = offset_ + scale_ * offset;
476 const double new_scale = max(min(scale, MaxScale), MinScale);
477 const double new_offset = cursor_offset - new_scale * offset;
478 set_scale_offset(new_scale, new_offset);
481 void View::calculate_tick_spacing()
483 const double SpacingIncrement = 32.0f;
484 const double MinValueSpacing = 32.0f;
486 double min_width = SpacingIncrement, typical_width;
488 QFontMetrics m(QApplication::font());
491 const double min_period = scale_ * min_width;
493 const int order = (int)floorf(log10f(min_period));
494 const double order_decimal = pow(10.0, order);
496 unsigned int unit = 0;
499 tick_period_ = order_decimal * ScaleUnits[unit++];
500 } while (tick_period_ < min_period &&
501 unit < countof(ScaleUnits));
503 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
505 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
506 Qt::AlignLeft | Qt::AlignTop,
507 format_time(offset_, tick_prefix_)).width() +
510 min_width += SpacingIncrement;
512 } while (typical_width > tick_period_ / scale_);
515 void View::update_scroll()
519 const QSize areaSize = viewport_->size();
521 // Set the horizontal scroll bar
522 double length = 0, offset = 0;
523 get_scroll_layout(length, offset);
524 length = max(length - areaSize.width(), 0.0);
526 int major_tick_distance = tick_period_ / scale_;
528 horizontalScrollBar()->setPageStep(areaSize.width() / 2);
529 horizontalScrollBar()->setSingleStep(major_tick_distance);
531 updating_scroll_ = true;
533 if (length < MaxScrollValue) {
534 horizontalScrollBar()->setRange(0, length);
535 horizontalScrollBar()->setSliderPosition(offset);
537 horizontalScrollBar()->setRange(0, MaxScrollValue);
538 horizontalScrollBar()->setSliderPosition(
539 offset_ * MaxScrollValue / (scale_ * length));
542 updating_scroll_ = false;
544 // Set the vertical scrollbar
545 verticalScrollBar()->setPageStep(areaSize.height());
546 verticalScrollBar()->setSingleStep(areaSize.height() / 8);
548 const pair<int, int> extents = v_extents();
549 verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
550 extents.second - (areaSize.height() / 2));
553 void View::update_layout()
556 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
557 ruler_->sizeHint().height(), 0, 0);
558 ruler_->setGeometry(viewport_->x(), 0,
559 viewport_->width(), ruler_->extended_size_hint().height());
560 header_->setGeometry(0, viewport_->y(),
561 header_->extended_size_hint().width(), viewport_->height());
565 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
572 QRectF View::label_rect(const QRectF &rect)
578 RowItemOwner* View::find_prevalent_trace_group(
579 const shared_ptr<sigrok::ChannelGroup> &group,
580 const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
585 unordered_set<RowItemOwner*> owners;
586 vector<RowItemOwner*> owner_list;
588 // Make a set and a list of all the owners
589 for (const auto &channel : group->channels()) {
590 const auto iter = signal_map.find(channel);
591 if (iter == signal_map.end())
594 RowItemOwner *const o = (*iter).second->owner();
595 owner_list.push_back(o);
599 // Iterate through the list of owners, and find the most prevalent
600 size_t max_prevalence = 0;
601 RowItemOwner *prevalent_owner = nullptr;
602 for (RowItemOwner *owner : owners) {
603 const size_t prevalence = std::count_if(
604 owner_list.begin(), owner_list.end(),
605 [&](RowItemOwner *o) { return o == owner; });
606 if (prevalence > max_prevalence) {
607 max_prevalence = prevalence;
608 prevalent_owner = owner;
612 return prevalent_owner;
615 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
616 const vector< shared_ptr<sigrok::Channel> > &channels,
617 const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
619 set< shared_ptr<Trace> > &add_list)
621 vector< shared_ptr<Trace> > filtered_traces;
623 for (const auto &channel : channels)
625 const auto map_iter = signal_map.find(channel);
626 if (map_iter == signal_map.end())
629 shared_ptr<Trace> trace = (*map_iter).second;
630 const auto list_iter = add_list.find(trace);
631 if (list_iter == add_list.end())
634 filtered_traces.push_back(trace);
635 add_list.erase(list_iter);
638 return filtered_traces;
641 bool View::eventFilter(QObject *object, QEvent *event)
643 const QEvent::Type type = event->type();
644 if (type == QEvent::MouseMove) {
646 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
647 if (object == viewport_)
648 hover_point_ = mouse_event->pos();
649 else if (object == ruler_)
650 hover_point_ = QPoint(mouse_event->x(), 0);
651 else if (object == header_)
652 hover_point_ = QPoint(0, mouse_event->y());
654 hover_point_ = QPoint(-1, -1);
656 hover_point_changed();
658 } else if (type == QEvent::Leave) {
659 hover_point_ = QPoint(-1, -1);
660 hover_point_changed();
663 return QObject::eventFilter(object, event);
666 bool View::viewportEvent(QEvent *e)
670 case QEvent::MouseButtonPress:
671 case QEvent::MouseButtonRelease:
672 case QEvent::MouseButtonDblClick:
673 case QEvent::MouseMove:
675 case QEvent::TouchBegin:
676 case QEvent::TouchUpdate:
677 case QEvent::TouchEnd:
681 return QAbstractScrollArea::viewportEvent(e);
685 void View::resizeEvent(QResizeEvent*)
690 void View::row_item_appearance_changed(bool label, bool content)
698 void View::time_item_appearance_changed(bool label, bool content)
706 void View::extents_changed(bool horz, bool vert)
709 (horz ? RowItemHExtentsChanged : 0) |
710 (vert ? RowItemVExtentsChanged : 0);
711 lazy_event_handler_.start();
714 void View::h_scroll_value_changed(int value)
716 if (updating_scroll_)
719 // Disable sticky scrolling when user moves the horizontal scroll bar
720 // during a running acquisition
721 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
722 sticky_scrolling_ = false;
723 sticky_scrolling_changed(false);
726 const int range = horizontalScrollBar()->maximum();
727 if (range < MaxScrollValue)
728 offset_ = scale_ * value;
730 double length = 0, offset;
731 get_scroll_layout(length, offset);
732 offset_ = scale_ * length * value / MaxScrollValue;
739 void View::v_scroll_value_changed()
745 void View::signals_changed()
747 vector< shared_ptr<RowItem> > new_top_level_items;
749 const auto device = session_.device();
753 shared_ptr<sigrok::Device> sr_dev = device->device();
756 // Make a list of traces that are being added, and a list of traces
757 // that are being removed
758 const set<shared_ptr<Trace>> prev_traces = list_by_type<Trace>();
760 shared_lock<shared_mutex> lock(session_.signals_mutex());
761 const unordered_set< shared_ptr<Signal> > &sigs(session_.signals());
763 set< shared_ptr<Trace> > traces(sigs.begin(), sigs.end());
766 const vector< shared_ptr<DecodeTrace> > decode_traces(
767 session().get_decode_signals());
768 traces.insert(decode_traces.begin(), decode_traces.end());
771 set< shared_ptr<Trace> > add_traces;
772 set_difference(traces.begin(), traces.end(),
773 prev_traces.begin(), prev_traces.end(),
774 inserter(add_traces, add_traces.begin()));
776 set< shared_ptr<Trace> > remove_traces;
777 set_difference(prev_traces.begin(), prev_traces.end(),
778 traces.begin(), traces.end(),
779 inserter(remove_traces, remove_traces.begin()));
781 // Make a look-up table of sigrok Channels to pulseview Signals
782 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
784 for (const shared_ptr<Signal> &sig : sigs)
785 signal_map[sig->channel()] = sig;
787 // Populate channel groups
788 for (auto entry : sr_dev->channel_groups())
790 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
792 if (group->channels().size() <= 1)
795 // Find best trace group to add to
796 RowItemOwner *owner = find_prevalent_trace_group(
799 // If there is no trace group, create one
800 shared_ptr<TraceGroup> new_trace_group;
802 new_trace_group.reset(new TraceGroup());
803 owner = new_trace_group.get();
806 // Extract traces for the trace group, removing them from
808 const vector< shared_ptr<Trace> > new_traces_in_group =
809 extract_new_traces_for_channels(group->channels(),
810 signal_map, add_traces);
812 // Add the traces to the group
813 const pair<int, int> prev_v_extents = owner->v_extents();
814 int offset = prev_v_extents.second - prev_v_extents.first;
815 for (shared_ptr<Trace> trace : new_traces_in_group) {
817 owner->add_child_item(trace);
819 const pair<int, int> extents = trace->v_extents();
820 if (trace->enabled())
821 offset += -extents.first;
822 trace->force_to_v_offset(offset);
823 if (trace->enabled())
824 offset += extents.second;
827 // If this is a new group, enqueue it in the new top level
829 if (!new_traces_in_group.empty() && new_trace_group)
830 new_top_level_items.push_back(new_trace_group);
833 // Enqueue the remaining channels as free ungrouped traces
834 const vector< shared_ptr<Trace> > new_top_level_signals =
835 extract_new_traces_for_channels(sr_dev->channels(),
836 signal_map, add_traces);
837 new_top_level_items.insert(new_top_level_items.end(),
838 new_top_level_signals.begin(), new_top_level_signals.end());
840 // Enqueue any remaining traces i.e. decode traces
841 new_top_level_items.insert(new_top_level_items.end(),
842 add_traces.begin(), add_traces.end());
844 // Remove any removed traces
845 for (shared_ptr<Trace> trace : remove_traces) {
846 RowItemOwner *const owner = trace->owner();
848 owner->remove_child_item(trace);
851 // Add and position the pending top levels items
852 for (auto item : new_top_level_items) {
853 add_child_item(item);
855 // Position the item after the last present item
856 int offset = v_extents().second;
857 const pair<int, int> extents = item->v_extents();
859 offset += -extents.first;
860 item->force_to_v_offset(offset);
862 offset += extents.second;
871 void View::data_updated()
873 // Reset "always zoom to fit" when we change to the stopped state
874 if (always_zoom_to_fit_ && (session_.get_capture_state() == Session::Stopped)) {
875 always_zoom_to_fit_ = false;
876 always_zoom_to_fit_changed(false);
879 if (always_zoom_to_fit_ || sticky_scrolling_) {
880 if (!delayed_view_updater_.isActive())
881 delayed_view_updater_.start();
889 void View::perform_delayed_view_update()
891 if (always_zoom_to_fit_)
894 if (sticky_scrolling_) {
895 // Make right side of the view sticky
896 double length = 0, offset;
897 get_scroll_layout(length, offset);
899 const QSize areaSize = viewport_->size();
900 length = max(length - areaSize.width(), 0.0);
902 offset_ = scale_ * length;
910 void View::process_sticky_events()
912 if (sticky_events_ & RowItemHExtentsChanged)
914 if (sticky_events_ & RowItemVExtentsChanged) {
915 restack_all_row_items();
919 // Clear the sticky events
923 void View::on_hover_point_changed()
925 for (shared_ptr<RowItem> r : *this)
926 r->hover_point_changed();