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;
90 const int View::ScaleUnits[3] = {1, 2, 5};
92 View::View(Session &session, QWidget *parent) :
93 QAbstractScrollArea(parent),
95 viewport_(new Viewport(*this)),
96 ruler_(new Ruler(*this)),
97 header_(new Header(*this)),
100 updating_scroll_(false),
103 show_cursors_(false),
104 cursors_(new CursorPair(*this)),
105 next_flag_text_('A'),
108 connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
109 this, SLOT(h_scroll_value_changed(int)));
110 connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
111 this, SLOT(v_scroll_value_changed()));
113 connect(&session_, SIGNAL(signals_changed()),
114 this, SLOT(signals_changed()));
115 connect(&session_, SIGNAL(capture_state_changed(int)),
116 this, SLOT(data_updated()));
117 connect(&session_, SIGNAL(data_received()),
118 this, SLOT(data_updated()));
119 connect(&session_, SIGNAL(frame_ended()),
120 this, SLOT(data_updated()));
122 connect(header_, SIGNAL(selection_changed()),
123 ruler_, SLOT(clear_selection()));
124 connect(ruler_, SIGNAL(selection_changed()),
125 header_, SLOT(clear_selection()));
127 connect(header_, SIGNAL(selection_changed()),
128 this, SIGNAL(selection_changed()));
129 connect(ruler_, SIGNAL(selection_changed()),
130 this, SIGNAL(selection_changed()));
132 connect(this, SIGNAL(hover_point_changed()),
133 this, SLOT(on_hover_point_changed()));
135 connect(&lazy_event_handler_, SIGNAL(timeout()),
136 this, SLOT(process_sticky_events()));
137 lazy_event_handler_.setSingleShot(true);
139 setViewport(viewport_);
141 viewport_->installEventFilter(this);
142 ruler_->installEventFilter(this);
143 header_->installEventFilter(this);
145 // Trigger the initial event manually. The default device has signals
146 // which were created before this object came into being
149 // make sure the transparent widgets are on the top
153 // Update the zoom state
154 calculate_tick_spacing();
157 Session& View::session()
162 const Session& View::session() const
172 const View* View::view() const
177 Viewport* View::viewport()
182 const Viewport* View::viewport() const
187 vector< shared_ptr<TimeItem> > View::time_items() const
189 const vector<shared_ptr<Flag>> f(flags());
190 vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
191 items.push_back(cursors_);
192 items.push_back(cursors_->first());
193 items.push_back(cursors_->second());
197 double View::scale() const
202 double View::offset() const
207 int View::owner_visual_v_offset() const
209 return -verticalScrollBar()->sliderPosition();
212 void View::set_v_offset(int offset)
214 verticalScrollBar()->setSliderPosition(offset);
219 unsigned int View::depth() const
224 unsigned int View::tick_prefix() const
229 double View::tick_period() const
234 void View::zoom(double steps)
236 zoom(steps, viewport_->width() / 2);
239 void View::zoom(double steps, int offset)
241 set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
244 void View::zoom_fit()
246 const pair<double, double> extents = get_time_extents();
247 const double delta = extents.second - extents.first;
252 const int w = viewport_->width();
256 const double scale = max(min(delta / w, MaxScale), MinScale);
257 set_scale_offset(scale, extents.first);
260 void View::zoom_one_to_one()
262 using pv::data::SignalData;
264 // Make a set of all the visible data objects
265 set< shared_ptr<SignalData> > visible_data = get_visible_data();
266 if (visible_data.empty())
269 double samplerate = 0.0;
270 for (const shared_ptr<SignalData> d : visible_data) {
272 const vector< shared_ptr<Segment> > segments =
274 for (const shared_ptr<Segment> &s : segments)
275 samplerate = max(samplerate, s->samplerate());
278 if (samplerate == 0.0)
282 const int w = viewport_->width();
286 set_zoom(1.0 / samplerate, w / 2);
289 void View::set_scale_offset(double scale, double offset)
294 calculate_tick_spacing();
299 scale_offset_changed();
302 set< shared_ptr<SignalData> > View::get_visible_data() const
304 shared_lock<shared_mutex> lock(session().signals_mutex());
305 const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
307 // Make a set of all the visible data objects
308 set< shared_ptr<SignalData> > visible_data;
309 for (const shared_ptr<Signal> sig : sigs)
311 visible_data.insert(sig->data());
316 pair<double, double> View::get_time_extents() const
318 double left_time = DBL_MAX, right_time = DBL_MIN;
319 const set< shared_ptr<SignalData> > visible_data = get_visible_data();
320 for (const shared_ptr<SignalData> d : visible_data)
322 const vector< shared_ptr<Segment> > segments =
324 for (const shared_ptr<Segment> &s : segments) {
325 double samplerate = s->samplerate();
326 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
328 const double start_time = s->start_time();
329 left_time = min(left_time, start_time);
330 right_time = max(right_time, start_time +
331 d->max_sample_count() / samplerate);
335 if (left_time == DBL_MAX && right_time == DBL_MIN)
336 return make_pair(0.0, 0.0);
338 assert(left_time < right_time);
339 return make_pair(left_time, right_time);
342 bool View::cursors_shown() const
344 return show_cursors_;
347 void View::show_cursors(bool show)
349 show_cursors_ = show;
354 void View::centre_cursors()
356 const double time_width = scale_ * viewport_->width();
357 cursors_->first()->set_time(offset_ + time_width * 0.4);
358 cursors_->second()->set_time(offset_ + time_width * 0.6);
363 std::shared_ptr<CursorPair> View::cursors() const
368 void View::add_flag(double time)
370 flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
371 QString("%1").arg(next_flag_text_))));
372 next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
373 (next_flag_text_ + 1);
374 time_item_appearance_changed(true, true);
377 void View::remove_flag(std::shared_ptr<Flag> flag)
380 time_item_appearance_changed(true, true);
383 vector< std::shared_ptr<Flag> > View::flags() const
385 vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
386 stable_sort(flags.begin(), flags.end(),
387 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
388 return a->time() < b->time();
394 const QPoint& View::hover_point() const
399 void View::update_viewport()
406 void View::restack_all_row_items()
408 // Make a list of owners that is sorted from deepest first
409 const auto owners = list_row_item_owners();
410 vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
411 sort(sorted_owners.begin(), sorted_owners.end(),
412 [](const RowItemOwner* a, const RowItemOwner *b) {
413 return a->depth() > b->depth(); });
415 // Restack the items recursively
416 for (auto &o : sorted_owners)
419 // Animate the items to their destination
420 for (const auto &r : *this)
421 r->animate_to_layout_v_offset();
424 void View::get_scroll_layout(double &length, double &offset) const
426 const pair<double, double> extents = get_time_extents();
427 length = (extents.second - extents.first) / scale_;
428 offset = offset_ / scale_;
431 void View::set_zoom(double scale, int offset)
433 const double cursor_offset = offset_ + scale_ * offset;
434 const double new_scale = max(min(scale, MaxScale), MinScale);
435 const double new_offset = cursor_offset - new_scale * offset;
436 set_scale_offset(new_scale, new_offset);
439 void View::calculate_tick_spacing()
441 const double SpacingIncrement = 32.0f;
442 const double MinValueSpacing = 32.0f;
444 double min_width = SpacingIncrement, typical_width;
446 QFontMetrics m(QApplication::font());
449 const double min_period = scale_ * min_width;
451 const int order = (int)floorf(log10f(min_period));
452 const double order_decimal = pow(10.0, order);
454 unsigned int unit = 0;
457 tick_period_ = order_decimal * ScaleUnits[unit++];
458 } while (tick_period_ < min_period &&
459 unit < countof(ScaleUnits));
461 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
463 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
464 Qt::AlignLeft | Qt::AlignTop,
465 format_time(offset_, tick_prefix_)).width() +
468 min_width += SpacingIncrement;
470 } while(typical_width > tick_period_ / scale_);
473 void View::update_scroll()
477 const QSize areaSize = viewport_->size();
479 // Set the horizontal scroll bar
480 double length = 0, offset = 0;
481 get_scroll_layout(length, offset);
482 length = max(length - areaSize.width(), 0.0);
484 int major_tick_distance = tick_period_ / scale_;
486 horizontalScrollBar()->setPageStep(areaSize.width() / 2);
487 horizontalScrollBar()->setSingleStep(major_tick_distance);
489 updating_scroll_ = true;
491 if (length < MaxScrollValue) {
492 horizontalScrollBar()->setRange(0, length);
493 horizontalScrollBar()->setSliderPosition(offset);
495 horizontalScrollBar()->setRange(0, MaxScrollValue);
496 horizontalScrollBar()->setSliderPosition(
497 offset_ * MaxScrollValue / (scale_ * length));
500 updating_scroll_ = false;
502 // Set the vertical scrollbar
503 verticalScrollBar()->setPageStep(areaSize.height());
504 verticalScrollBar()->setSingleStep(areaSize.height() / 8);
506 const pair<int, int> extents = v_extents();
507 verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
508 extents.second - (areaSize.height() / 2));
511 void View::update_layout()
514 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
515 ruler_->sizeHint().height(), 0, 0);
516 ruler_->setGeometry(viewport_->x(), 0,
517 viewport_->width(), ruler_->extended_size_hint().height());
518 header_->setGeometry(0, viewport_->y(),
519 header_->extended_size_hint().width(), viewport_->height());
523 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
530 QRectF View::label_rect(const QRectF &rect)
536 RowItemOwner* View::find_prevalent_trace_group(
537 const shared_ptr<sigrok::ChannelGroup> &group,
538 const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
543 unordered_set<RowItemOwner*> owners;
544 vector<RowItemOwner*> owner_list;
546 // Make a set and a list of all the owners
547 for (const auto &channel : group->channels()) {
548 const auto iter = signal_map.find(channel);
549 if (iter == signal_map.end())
552 RowItemOwner *const o = (*iter).second->owner();
553 owner_list.push_back(o);
557 // Iterate through the list of owners, and find the most prevalent
558 size_t max_prevalence = 0;
559 RowItemOwner *prevalent_owner = nullptr;
560 for (RowItemOwner *owner : owners) {
561 const size_t prevalence = std::count_if(
562 owner_list.begin(), owner_list.end(),
563 [&](RowItemOwner *o) { return o == owner; });
564 if (prevalence > max_prevalence) {
565 max_prevalence = prevalence;
566 prevalent_owner = owner;
570 return prevalent_owner;
573 vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
574 const vector< shared_ptr<sigrok::Channel> > &channels,
575 const unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
577 set< shared_ptr<Trace> > &add_list)
579 vector< shared_ptr<Trace> > filtered_traces;
581 for (const auto &channel : channels)
583 const auto map_iter = signal_map.find(channel);
584 if (map_iter == signal_map.end())
587 shared_ptr<Trace> trace = (*map_iter).second;
588 const auto list_iter = add_list.find(trace);
589 if (list_iter == add_list.end())
592 filtered_traces.push_back(trace);
593 add_list.erase(list_iter);
596 return filtered_traces;
599 bool View::eventFilter(QObject *object, QEvent *event)
601 const QEvent::Type type = event->type();
602 if (type == QEvent::MouseMove) {
604 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
605 if (object == viewport_)
606 hover_point_ = mouse_event->pos();
607 else if (object == ruler_)
608 hover_point_ = QPoint(mouse_event->x(), 0);
609 else if (object == header_)
610 hover_point_ = QPoint(0, mouse_event->y());
612 hover_point_ = QPoint(-1, -1);
614 hover_point_changed();
616 } else if (type == QEvent::Leave) {
617 hover_point_ = QPoint(-1, -1);
618 hover_point_changed();
621 return QObject::eventFilter(object, event);
624 bool View::viewportEvent(QEvent *e)
628 case QEvent::MouseButtonPress:
629 case QEvent::MouseButtonRelease:
630 case QEvent::MouseButtonDblClick:
631 case QEvent::MouseMove:
633 case QEvent::TouchBegin:
634 case QEvent::TouchUpdate:
635 case QEvent::TouchEnd:
639 return QAbstractScrollArea::viewportEvent(e);
643 void View::resizeEvent(QResizeEvent*)
648 void View::row_item_appearance_changed(bool label, bool content)
656 void View::time_item_appearance_changed(bool label, bool content)
664 void View::extents_changed(bool horz, bool vert)
667 (horz ? RowItemHExtentsChanged : 0) |
668 (vert ? RowItemVExtentsChanged : 0);
669 lazy_event_handler_.start();
672 void View::h_scroll_value_changed(int value)
674 if (updating_scroll_)
677 const int range = horizontalScrollBar()->maximum();
678 if (range < MaxScrollValue)
679 offset_ = scale_ * value;
681 double length = 0, offset;
682 get_scroll_layout(length, offset);
683 offset_ = scale_ * length * value / MaxScrollValue;
690 void View::v_scroll_value_changed()
696 void View::signals_changed()
698 vector< shared_ptr<RowItem> > new_top_level_items;
700 const auto device = session_.device();
704 shared_ptr<sigrok::Device> sr_dev = device->device();
707 // Make a list of traces that are being added, and a list of traces
708 // that are being removed
709 const set<shared_ptr<Trace>> prev_traces = list_by_type<Trace>();
711 shared_lock<shared_mutex> lock(session_.signals_mutex());
712 const unordered_set< shared_ptr<Signal> > &sigs(session_.signals());
714 set< shared_ptr<Trace> > traces(sigs.begin(), sigs.end());
717 const vector< shared_ptr<DecodeTrace> > decode_traces(
718 session().get_decode_signals());
719 traces.insert(decode_traces.begin(), decode_traces.end());
722 set< shared_ptr<Trace> > add_traces;
723 set_difference(traces.begin(), traces.end(),
724 prev_traces.begin(), prev_traces.end(),
725 inserter(add_traces, add_traces.begin()));
727 set< shared_ptr<Trace> > remove_traces;
728 set_difference(prev_traces.begin(), prev_traces.end(),
729 traces.begin(), traces.end(),
730 inserter(remove_traces, remove_traces.begin()));
732 // Make a look-up table of sigrok Channels to pulseview Signals
733 unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
735 for (const shared_ptr<Signal> &sig : sigs)
736 signal_map[sig->channel()] = sig;
738 // Populate channel groups
739 for (auto entry : sr_dev->channel_groups())
741 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
743 if (group->channels().size() <= 1)
746 // Find best trace group to add to
747 RowItemOwner *owner = find_prevalent_trace_group(
750 // If there is no trace group, create one
751 shared_ptr<TraceGroup> new_trace_group;
753 new_trace_group.reset(new TraceGroup());
754 owner = new_trace_group.get();
757 // Extract traces for the trace group, removing them from
759 const vector< shared_ptr<Trace> > new_traces_in_group =
760 extract_new_traces_for_channels(group->channels(),
761 signal_map, add_traces);
763 // Add the traces to the group
764 const pair<int, int> prev_v_extents = owner->v_extents();
765 int offset = prev_v_extents.second - prev_v_extents.first;
766 for (shared_ptr<Trace> trace : new_traces_in_group) {
768 owner->add_child_item(trace);
770 const pair<int, int> extents = trace->v_extents();
771 if (trace->enabled())
772 offset += -extents.first;
773 trace->force_to_v_offset(offset);
774 if (trace->enabled())
775 offset += extents.second;
778 // If this is a new group, enqueue it in the new top level
780 if (!new_traces_in_group.empty() && new_trace_group)
781 new_top_level_items.push_back(new_trace_group);
784 // Enqueue the remaining channels as free ungrouped traces
785 const vector< shared_ptr<Trace> > new_top_level_signals =
786 extract_new_traces_for_channels(sr_dev->channels(),
787 signal_map, add_traces);
788 new_top_level_items.insert(new_top_level_items.end(),
789 new_top_level_signals.begin(), new_top_level_signals.end());
791 // Enqueue any remaining traces i.e. decode traces
792 new_top_level_items.insert(new_top_level_items.end(),
793 add_traces.begin(), add_traces.end());
795 // Remove any removed traces
796 for (shared_ptr<Trace> trace : remove_traces) {
797 RowItemOwner *const owner = trace->owner();
799 owner->remove_child_item(trace);
802 // Add and position the pending top levels items
803 for (auto item : new_top_level_items) {
804 add_child_item(item);
806 // Position the item after the last present item
807 int offset = v_extents().second;
808 const pair<int, int> extents = item->v_extents();
810 offset += -extents.first;
811 item->force_to_v_offset(offset);
813 offset += extents.second;
822 void View::data_updated()
824 // Update the scroll bars
831 void View::process_sticky_events()
833 if (sticky_events_ & RowItemHExtentsChanged)
835 if (sticky_events_ & RowItemVExtentsChanged) {
836 restack_all_row_items();
840 // Clear the sticky events
844 void View::on_hover_point_changed()
846 for (shared_ptr<RowItem> r : *this)
847 r->hover_point_changed();