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
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()
105 show_cursors_(false),
106 cursors_(new CursorPair(*this)),
107 next_flag_text_('A'),
110 connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
111 this, SLOT(h_scroll_value_changed(int)));
112 connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
113 this, SLOT(v_scroll_value_changed()));
115 connect(&session_, SIGNAL(signals_changed()),
116 this, SLOT(signals_changed()));
117 connect(&session_, SIGNAL(capture_state_changed(int)),
118 this, SLOT(data_updated()));
119 connect(&session_, SIGNAL(data_received()),
120 this, SLOT(data_updated()));
121 connect(&session_, SIGNAL(frame_ended()),
122 this, SLOT(data_updated()));
124 connect(header_, SIGNAL(selection_changed()),
125 ruler_, SLOT(clear_selection()));
126 connect(ruler_, SIGNAL(selection_changed()),
127 header_, SLOT(clear_selection()));
129 connect(header_, SIGNAL(selection_changed()),
130 this, SIGNAL(selection_changed()));
131 connect(ruler_, SIGNAL(selection_changed()),
132 this, SIGNAL(selection_changed()));
134 connect(this, SIGNAL(hover_point_changed()),
135 this, SLOT(on_hover_point_changed()));
137 connect(&lazy_event_handler_, SIGNAL(timeout()),
138 this, SLOT(process_sticky_events()));
139 lazy_event_handler_.setSingleShot(true);
141 connect(&delayed_view_updater_, SIGNAL(timeout()),
142 this, SLOT(perform_delayed_view_update()));
143 delayed_view_updater_.setSingleShot(true);
144 delayed_view_updater_.setInterval(1000 / MaxViewAutoUpdateRate);
146 setViewport(viewport_);
148 viewport_->installEventFilter(this);
149 ruler_->installEventFilter(this);
150 header_->installEventFilter(this);
152 // Trigger the initial event manually. The default device has signals
153 // which were created before this object came into being
156 // make sure the transparent widgets are on the top
160 // Update the zoom state
161 calculate_tick_spacing();
164 Session& View::session()
169 const Session& View::session() const
179 const View* View::view() const
184 Viewport* View::viewport()
189 const Viewport* View::viewport() const
194 vector< shared_ptr<TimeItem> > View::time_items() const
196 const vector<shared_ptr<Flag>> f(flags());
197 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
198 items.push_back(cursors_);
199 items.push_back(cursors_->first());
200 items.push_back(cursors_->second());
204 double View::scale() const
209 double View::offset() const
214 int View::owner_visual_v_offset() const
216 return -verticalScrollBar()->sliderPosition();
219 void View::set_v_offset(int offset)
221 verticalScrollBar()->setSliderPosition(offset);
226 unsigned int View::depth() const
231 unsigned int View::tick_prefix() const
236 double View::tick_period() const
241 void View::zoom(double steps)
243 zoom(steps, viewport_->width() / 2);
246 void View::zoom(double steps, int offset)
248 set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
251 void View::zoom_fit()
253 const pair<double, double> extents = get_time_extents();
254 const double delta = extents.second - extents.first;
259 const int w = viewport_->width();
263 const double scale = max(min(delta / w, MaxScale), MinScale);
264 set_scale_offset(scale, extents.first);
267 void View::zoom_one_to_one()
269 using pv::data::SignalData;
271 // Make a set of all the visible data objects
272 set< shared_ptr<SignalData> > visible_data = get_visible_data();
273 if (visible_data.empty())
276 double samplerate = 0.0;
277 for (const shared_ptr<SignalData> d : visible_data) {
279 const vector< shared_ptr<Segment> > segments =
281 for (const shared_ptr<Segment> &s : segments)
282 samplerate = max(samplerate, s->samplerate());
285 if (samplerate == 0.0)
289 const int w = viewport_->width();
293 set_zoom(1.0 / samplerate, w / 2);
296 void View::set_scale_offset(double scale, double offset)
298 // Disable sticky scrolling when acquisition runs and user drags the viewport
299 if ((scale_ == scale) && (offset_ != offset) &&
300 sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
301 sticky_scrolling_ = false;
302 sticky_scrolling_changed(false);
308 calculate_tick_spacing();
313 scale_offset_changed();
316 set< shared_ptr<SignalData> > View::get_visible_data() const
318 shared_lock<shared_mutex> lock(session().signals_mutex());
319 const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
321 // Make a set of all the visible data objects
322 set< shared_ptr<SignalData> > visible_data;
323 for (const shared_ptr<Signal> sig : sigs)
325 visible_data.insert(sig->data());
330 pair<double, double> View::get_time_extents() const
332 double left_time = DBL_MAX, right_time = DBL_MIN;
333 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
334 for (const shared_ptr<SignalData> d : visible_data)
336 const vector< shared_ptr<Segment> > segments =
338 for (const shared_ptr<Segment> &s : segments) {
339 double samplerate = s->samplerate();
340 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
342 const double start_time = s->start_time();
343 left_time = min(left_time, start_time);
344 right_time = max(right_time, start_time +
345 d->max_sample_count() / samplerate);
349 if (left_time == DBL_MAX && right_time == DBL_MIN)
350 return make_pair(0.0, 0.0);
352 assert(left_time < right_time);
353 return make_pair(left_time, right_time);
356 void View::enable_sticky_scrolling(bool state)
358 sticky_scrolling_ = state;
361 bool View::cursors_shown() const
363 return show_cursors_;
366 void View::show_cursors(bool show)
368 show_cursors_ = show;
373 void View::centre_cursors()
375 const double time_width = scale_ * viewport_->width();
376 cursors_->first()->set_time(offset_ + time_width * 0.4);
377 cursors_->second()->set_time(offset_ + time_width * 0.6);
382 std::shared_ptr<CursorPair> View::cursors() const
387 void View::add_flag(double time)
389 flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
390 QString("%1").arg(next_flag_text_))));
391 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
392 (next_flag_text_ + 1);
393 time_item_appearance_changed(true, true);
396 void View::remove_flag(std::shared_ptr<Flag> flag)
399 time_item_appearance_changed(true, true);
402 vector< std::shared_ptr<Flag> > View::flags() const
404 vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
405 stable_sort(flags.begin(), flags.end(),
406 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
407 return a->time() < b->time();
413 const QPoint& View::hover_point() const
418 void View::update_viewport()
425 void View::restack_all_row_items()
427 // Make a list of owners that is sorted from deepest first
428 const auto owners = list_row_item_owners();
429 vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
430 sort(sorted_owners.begin(), sorted_owners.end(),
431 [](const RowItemOwner* a, const RowItemOwner *b) {
432 return a->depth() > b->depth(); });
434 // Restack the items recursively
435 for (auto &o : sorted_owners)
438 // Animate the items to their destination
439 for (const auto &r : *this)
440 r->animate_to_layout_v_offset();
443 void View::get_scroll_layout(double &length, double &offset) const
445 const pair<double, double> extents = get_time_extents();
446 length = (extents.second - extents.first) / scale_;
447 offset = offset_ / scale_;
450 void View::set_zoom(double scale, int offset)
452 const double cursor_offset = offset_ + scale_ * offset;
453 const double new_scale = max(min(scale, MaxScale), MinScale);
454 const double new_offset = cursor_offset - new_scale * offset;
455 set_scale_offset(new_scale, new_offset);
458 void View::calculate_tick_spacing()
460 const double SpacingIncrement = 32.0f;
461 const double MinValueSpacing = 32.0f;
463 double min_width = SpacingIncrement, typical_width;
465 QFontMetrics m(QApplication::font());
468 const double min_period = scale_ * min_width;
470 const int order = (int)floorf(log10f(min_period));
471 const double order_decimal = pow(10.0, order);
473 unsigned int unit = 0;
476 tick_period_ = order_decimal * ScaleUnits[unit++];
477 } while (tick_period_ < min_period &&
478 unit < countof(ScaleUnits));
480 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
482 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
483 Qt::AlignLeft | Qt::AlignTop,
484 format_time(offset_, tick_prefix_)).width() +
487 min_width += SpacingIncrement;
489 } while(typical_width > tick_period_ / scale_);
492 void View::update_scroll()
496 const QSize areaSize = viewport_->size();
498 // Set the horizontal scroll bar
499 double length = 0, offset = 0;
500 get_scroll_layout(length, offset);
501 length = max(length - areaSize.width(), 0.0);
503 int major_tick_distance = tick_period_ / scale_;
505 horizontalScrollBar()->setPageStep(areaSize.width() / 2);
506 horizontalScrollBar()->setSingleStep(major_tick_distance);
508 updating_scroll_ = true;
510 if (length < MaxScrollValue) {
511 horizontalScrollBar()->setRange(0, length);
512 horizontalScrollBar()->setSliderPosition(offset);
514 horizontalScrollBar()->setRange(0, MaxScrollValue);
515 horizontalScrollBar()->setSliderPosition(
516 offset_ * MaxScrollValue / (scale_ * length));
519 updating_scroll_ = false;
521 // Set the vertical scrollbar
522 verticalScrollBar()->setPageStep(areaSize.height());
523 verticalScrollBar()->setSingleStep(areaSize.height() / 8);
525 const pair<int, int> extents = v_extents();
526 verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
527 extents.second - (areaSize.height() / 2));
530 void View::update_layout()
533 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
534 ruler_->sizeHint().height(), 0, 0);
535 ruler_->setGeometry(viewport_->x(), 0,
536 viewport_->width(), ruler_->extended_size_hint().height());
537 header_->setGeometry(0, viewport_->y(),
538 header_->extended_size_hint().width(), viewport_->height());
542 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
549 QRectF View::label_rect(const QRectF &rect)
555 RowItemOwner* View::find_prevalent_trace_group(
556 const shared_ptr<sigrok::ChannelGroup> &group,
557 const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
562 unordered_set<RowItemOwner*> owners;
563 vector<RowItemOwner*> owner_list;
565 // Make a set and a list of all the owners
566 for (const auto &channel : group->channels()) {
567 const auto iter = signal_map.find(channel);
568 if (iter == signal_map.end())
571 RowItemOwner *const o = (*iter).second->owner();
572 owner_list.push_back(o);
576 // Iterate through the list of owners, and find the most prevalent
577 size_t max_prevalence = 0;
578 RowItemOwner *prevalent_owner = nullptr;
579 for (RowItemOwner *owner : owners) {
580 const size_t prevalence = std::count_if(
581 owner_list.begin(), owner_list.end(),
582 [&](RowItemOwner *o) { return o == owner; });
583 if (prevalence > max_prevalence) {
584 max_prevalence = prevalence;
585 prevalent_owner = owner;
589 return prevalent_owner;
592 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
593 const vector< shared_ptr<sigrok::Channel> > &channels,
594 const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
596 set< shared_ptr<Trace> > &add_list)
598 vector< shared_ptr<Trace> > filtered_traces;
600 for (const auto &channel : channels)
602 const auto map_iter = signal_map.find(channel);
603 if (map_iter == signal_map.end())
606 shared_ptr<Trace> trace = (*map_iter).second;
607 const auto list_iter = add_list.find(trace);
608 if (list_iter == add_list.end())
611 filtered_traces.push_back(trace);
612 add_list.erase(list_iter);
615 return filtered_traces;
618 bool View::eventFilter(QObject *object, QEvent *event)
620 const QEvent::Type type = event->type();
621 if (type == QEvent::MouseMove) {
623 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
624 if (object == viewport_)
625 hover_point_ = mouse_event->pos();
626 else if (object == ruler_)
627 hover_point_ = QPoint(mouse_event->x(), 0);
628 else if (object == header_)
629 hover_point_ = QPoint(0, mouse_event->y());
631 hover_point_ = QPoint(-1, -1);
633 hover_point_changed();
635 } else if (type == QEvent::Leave) {
636 hover_point_ = QPoint(-1, -1);
637 hover_point_changed();
640 return QObject::eventFilter(object, event);
643 bool View::viewportEvent(QEvent *e)
647 case QEvent::MouseButtonPress:
648 case QEvent::MouseButtonRelease:
649 case QEvent::MouseButtonDblClick:
650 case QEvent::MouseMove:
652 case QEvent::TouchBegin:
653 case QEvent::TouchUpdate:
654 case QEvent::TouchEnd:
658 return QAbstractScrollArea::viewportEvent(e);
662 void View::resizeEvent(QResizeEvent*)
667 void View::row_item_appearance_changed(bool label, bool content)
675 void View::time_item_appearance_changed(bool label, bool content)
683 void View::extents_changed(bool horz, bool vert)
686 (horz ? RowItemHExtentsChanged : 0) |
687 (vert ? RowItemVExtentsChanged : 0);
688 lazy_event_handler_.start();
691 void View::h_scroll_value_changed(int value)
693 if (updating_scroll_)
696 // Disable sticky scrolling when user moves the horizontal scroll bar
697 // during a running acquisition
698 if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
699 sticky_scrolling_ = false;
700 sticky_scrolling_changed(false);
703 const int range = horizontalScrollBar()->maximum();
704 if (range < MaxScrollValue)
705 offset_ = scale_ * value;
707 double length = 0, offset;
708 get_scroll_layout(length, offset);
709 offset_ = scale_ * length * value / MaxScrollValue;
716 void View::v_scroll_value_changed()
722 void View::signals_changed()
724 vector< shared_ptr<RowItem> > new_top_level_items;
726 const auto device = session_.device();
730 shared_ptr<sigrok::Device> sr_dev = device->device();
733 // Make a list of traces that are being added, and a list of traces
734 // that are being removed
735 const set<shared_ptr<Trace>> prev_traces = list_by_type<Trace>();
737 shared_lock<shared_mutex> lock(session_.signals_mutex());
738 const unordered_set< shared_ptr<Signal> > &sigs(session_.signals());
740 set< shared_ptr<Trace> > traces(sigs.begin(), sigs.end());
743 const vector< shared_ptr<DecodeTrace> > decode_traces(
744 session().get_decode_signals());
745 traces.insert(decode_traces.begin(), decode_traces.end());
748 set< shared_ptr<Trace> > add_traces;
749 set_difference(traces.begin(), traces.end(),
750 prev_traces.begin(), prev_traces.end(),
751 inserter(add_traces, add_traces.begin()));
753 set< shared_ptr<Trace> > remove_traces;
754 set_difference(prev_traces.begin(), prev_traces.end(),
755 traces.begin(), traces.end(),
756 inserter(remove_traces, remove_traces.begin()));
758 // Make a look-up table of sigrok Channels to pulseview Signals
759 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
761 for (const shared_ptr<Signal> &sig : sigs)
762 signal_map[sig->channel()] = sig;
764 // Populate channel groups
765 for (auto entry : sr_dev->channel_groups())
767 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
769 if (group->channels().size() <= 1)
772 // Find best trace group to add to
773 RowItemOwner *owner = find_prevalent_trace_group(
776 // If there is no trace group, create one
777 shared_ptr<TraceGroup> new_trace_group;
779 new_trace_group.reset(new TraceGroup());
780 owner = new_trace_group.get();
783 // Extract traces for the trace group, removing them from
785 const vector< shared_ptr<Trace> > new_traces_in_group =
786 extract_new_traces_for_channels(group->channels(),
787 signal_map, add_traces);
789 // Add the traces to the group
790 const pair<int, int> prev_v_extents = owner->v_extents();
791 int offset = prev_v_extents.second - prev_v_extents.first;
792 for (shared_ptr<Trace> trace : new_traces_in_group) {
794 owner->add_child_item(trace);
796 const pair<int, int> extents = trace->v_extents();
797 if (trace->enabled())
798 offset += -extents.first;
799 trace->force_to_v_offset(offset);
800 if (trace->enabled())
801 offset += extents.second;
804 // If this is a new group, enqueue it in the new top level
806 if (!new_traces_in_group.empty() && new_trace_group)
807 new_top_level_items.push_back(new_trace_group);
810 // Enqueue the remaining channels as free ungrouped traces
811 const vector< shared_ptr<Trace> > new_top_level_signals =
812 extract_new_traces_for_channels(sr_dev->channels(),
813 signal_map, add_traces);
814 new_top_level_items.insert(new_top_level_items.end(),
815 new_top_level_signals.begin(), new_top_level_signals.end());
817 // Enqueue any remaining traces i.e. decode traces
818 new_top_level_items.insert(new_top_level_items.end(),
819 add_traces.begin(), add_traces.end());
821 // Remove any removed traces
822 for (shared_ptr<Trace> trace : remove_traces) {
823 RowItemOwner *const owner = trace->owner();
825 owner->remove_child_item(trace);
828 // Add and position the pending top levels items
829 for (auto item : new_top_level_items) {
830 add_child_item(item);
832 // Position the item after the last present item
833 int offset = v_extents().second;
834 const pair<int, int> extents = item->v_extents();
836 offset += -extents.first;
837 item->force_to_v_offset(offset);
839 offset += extents.second;
848 void View::data_updated()
850 if (sticky_scrolling_) {
851 if (!delayed_view_updater_.isActive())
852 delayed_view_updater_.start();
860 void View::perform_delayed_view_update()
862 if (sticky_scrolling_) {
863 // Make right side of the view sticky
864 double length = 0, offset;
865 get_scroll_layout(length, offset);
867 const QSize areaSize = viewport_->size();
868 length = max(length - areaSize.width(), 0.0);
870 offset_ = scale_ * length;
878 void View::process_sticky_events()
880 if (sticky_events_ & RowItemHExtentsChanged)
882 if (sticky_events_ & RowItemVExtentsChanged) {
883 restack_all_row_items();
887 // Clear the sticky events
891 void View::on_hover_point_changed()
893 for (shared_ptr<RowItem> r : *this)
894 r->hover_point_changed();