pv/view/view.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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 #ifdef ENABLE_DECODE
  22 #include <libsigrokdecode/libsigrokdecode.h>
  23 #endif
  24
  25 #include <extdef.h>
  26
  27 #include <cassert>
  28 #include <climits>
  29 #include <cmath>
  30 #include <mutex>
  31 #include <unordered_set>
  32
  33 #include <QApplication>
  34 #include <QEvent>
  35 #include <QFontMetrics>
  36 #include <QMouseEvent>
  37 #include <QScrollBar>
  38
  39 #include <libsigrok/libsigrok.hpp>
  40
  41 #include "decodetrace.hpp"
  42 #include "header.hpp"
  43 #include "logicsignal.hpp"
  44 #include "ruler.hpp"
  45 #include "signal.hpp"
  46 #include "tracegroup.hpp"
  47 #include "view.hpp"
  48 #include "viewport.hpp"
  49
  50 #include "pv/session.hpp"
  51 #include "pv/data/logic.hpp"
  52 #include "pv/data/logicsegment.hpp"
  53 #include "pv/util.hpp"
  54
  55 using boost::shared_lock;
  56 using boost::shared_mutex;
  57
  58 using pv::data::SignalData;
  59 using pv::data::Segment;
  60 using pv::util::format_time;
  61
  62 using std::deque;
  63 using std::dynamic_pointer_cast;
  64 using std::list;
  65 using std::lock_guard;
  66 using std::max;
  67 using std::make_pair;
  68 using std::min;
  69 using std::pair;
  70 using std::set;
  71 using std::shared_ptr;
  72 using std::unordered_map;
  73 using std::unordered_set;
  74 using std::vector;
  75 using std::weak_ptr;
  76
  77 namespace pv {
  78 namespace view {
  79
  80 const double View::MaxScale = 1e9;
  81 const double View::MinScale = 1e-15;
  82
  83 const int View::MaxScrollValue = INT_MAX / 2;
  84
  85 const int View::ScaleUnits[3] = {1, 2, 5};
  86
  87 View::View(Session &session, QWidget *parent) :
  88         QAbstractScrollArea(parent),
  89         session_(session),
  90         viewport_(new Viewport(*this)),
  91         ruler_(new Ruler(*this)),
  92         header_(new Header(*this)),
  93         scale_(1e-6),
  94         offset_(0),
  95         updating_scroll_(false),
  96         tick_period_(0.0),
  97         tick_prefix_(0),
  98         show_cursors_(false),
  99         cursors_(new CursorPair(*this)),
 100         next_flag_text_('A'),
 101         hover_point_(-1, -1)
 102 {
 103         connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
 104                 this, SLOT(h_scroll_value_changed(int)));
 105         connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
 106                 this, SLOT(v_scroll_value_changed()));
 107
 108         connect(&session_, SIGNAL(signals_changed()),
 109                 this, SLOT(signals_changed()));
 110         connect(&session_, SIGNAL(capture_state_changed(int)),
 111                 this, SLOT(data_updated()));
 112         connect(&session_, SIGNAL(data_received()),
 113                 this, SLOT(data_updated()));
 114         connect(&session_, SIGNAL(frame_ended()),
 115                 this, SLOT(data_updated()));
 116
 117         connect(header_, SIGNAL(selection_changed()),
 118                 ruler_, SLOT(clear_selection()));
 119         connect(ruler_, SIGNAL(selection_changed()),
 120                 header_, SLOT(clear_selection()));
 121
 122         connect(header_, SIGNAL(selection_changed()),
 123                 this, SIGNAL(selection_changed()));
 124         connect(ruler_, SIGNAL(selection_changed()),
 125                 this, SIGNAL(selection_changed()));
 126
 127         connect(this, SIGNAL(hover_point_changed()),
 128                 this, SLOT(on_hover_point_changed()));
 129
 130         connect(&lazy_event_handler_, SIGNAL(timeout()),
 131                 this, SLOT(process_sticky_events()));
 132         lazy_event_handler_.setSingleShot(true);
 133
 134         setViewport(viewport_);
 135
 136         viewport_->installEventFilter(this);
 137         ruler_->installEventFilter(this);
 138         header_->installEventFilter(this);
 139
 140         // Trigger the initial event manually. The default device has signals
 141         // which were created before this object came into being
 142         signals_changed();
 143
 144         // make sure the transparent widgets are on the top
 145         ruler_->raise();
 146         header_->raise();
 147
 148         // Update the zoom state
 149         calculate_tick_spacing();
 150 }
 151
 152 Session& View::session()
 153 {
 154         return session_;
 155 }
 156
 157 const Session& View::session() const
 158 {
 159         return session_;
 160 }
 161
 162 View* View::view()
 163 {
 164         return this;
 165 }
 166
 167 const View* View::view() const
 168 {
 169         return this;
 170 }
 171
 172 Viewport* View::viewport()
 173 {
 174         return viewport_;
 175 }
 176
 177 const Viewport* View::viewport() const
 178 {
 179         return viewport_;
 180 }
 181
 182 vector< shared_ptr<TimeItem> > View::time_items() const
 183 {
 184         const vector<shared_ptr<Flag>> f(flags());
 185         vector<shared_ptr<TimeItem>> items(f.begin(), f.end());
 186         items.push_back(cursors_);
 187         items.push_back(cursors_->first());
 188         items.push_back(cursors_->second());
 189         return items;
 190 }
 191
 192 double View::scale() const
 193 {
 194         return scale_;
 195 }
 196
 197 double View::offset() const
 198 {
 199         return offset_;
 200 }
 201
 202 int View::owner_visual_v_offset() const
 203 {
 204         return -verticalScrollBar()->sliderPosition();
 205 }
 206
 207 void View::set_v_offset(int offset)
 208 {
 209         verticalScrollBar()->setSliderPosition(offset);
 210         header_->update();
 211         viewport_->update();
 212 }
 213
 214 unsigned int View::depth() const
 215 {
 216         return 0;
 217 }
 218
 219 unsigned int View::tick_prefix() const
 220 {
 221         return tick_prefix_;
 222 }
 223
 224 double View::tick_period() const
 225 {
 226         return tick_period_;
 227 }
 228
 229 void View::zoom(double steps)
 230 {
 231         zoom(steps, viewport_->width() / 2);
 232 }
 233
 234 void View::zoom(double steps, int offset)
 235 {
 236         set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
 237 }
 238
 239 void View::zoom_fit()
 240 {
 241         const pair<double, double> extents = get_time_extents();
 242         const double delta = extents.second - extents.first;
 243         if (delta < 1e-12)
 244                 return;
 245
 246         assert(viewport_);
 247         const int w = viewport_->width();
 248         if (w <= 0)
 249                 return;
 250
 251         const double scale = max(min(delta / w, MaxScale), MinScale);
 252         set_scale_offset(scale, extents.first);
 253 }
 254
 255 void View::zoom_one_to_one()
 256 {
 257         using pv::data::SignalData;
 258
 259         // Make a set of all the visible data objects
 260         set< shared_ptr<SignalData> > visible_data = get_visible_data();
 261         if (visible_data.empty())
 262                 return;
 263
 264         double samplerate = 0.0;
 265         for (const shared_ptr<SignalData> d : visible_data) {
 266                 assert(d);
 267                 const vector< shared_ptr<Segment> > segments =
 268                         d->segments();
 269                 for (const shared_ptr<Segment> &s : segments)
 270                         samplerate = max(samplerate, s->samplerate());
 271         }
 272
 273         if (samplerate == 0.0)
 274                 return;
 275
 276         assert(viewport_);
 277         const int w = viewport_->width();
 278         if (w <= 0)
 279                 return;
 280
 281         set_zoom(1.0 / samplerate, w / 2);
 282 }
 283
 284 void View::set_scale_offset(double scale, double offset)
 285 {
 286         scale_ = scale;
 287         offset_ = offset;
 288
 289         calculate_tick_spacing();
 290
 291         update_scroll();
 292         ruler_->update();
 293         viewport_->update();
 294         scale_offset_changed();
 295 }
 296
 297 set< shared_ptr<SignalData> > View::get_visible_data() const
 298 {
 299         shared_lock<shared_mutex> lock(session().signals_mutex());
 300         const vector< shared_ptr<Signal> > &sigs(session().signals());
 301
 302         // Make a set of all the visible data objects
 303         set< shared_ptr<SignalData> > visible_data;
 304         for (const shared_ptr<Signal> sig : sigs)
 305                 if (sig->enabled())
 306                         visible_data.insert(sig->data());
 307
 308         return visible_data;
 309 }
 310
 311 pair<double, double> View::get_time_extents() const
 312 {
 313         double left_time = DBL_MAX, right_time = DBL_MIN;
 314         const set< shared_ptr<SignalData> > visible_data = get_visible_data();
 315         for (const shared_ptr<SignalData> d : visible_data)
 316         {
 317                 const vector< shared_ptr<Segment> > segments =
 318                         d->segments();
 319                 for (const shared_ptr<Segment> &s : segments) {
 320                         double samplerate = s->samplerate();
 321                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 322
 323                         const double start_time = s->start_time();
 324                         left_time = min(left_time, start_time);
 325                         right_time = max(right_time, start_time +
 326                                 d->get_max_sample_count() / samplerate);
 327                 }
 328         }
 329
 330         if (left_time == DBL_MAX && right_time == DBL_MIN)
 331                 return make_pair(0.0, 0.0);
 332
 333         assert(left_time < right_time);
 334         return make_pair(left_time, right_time);
 335 }
 336
 337 bool View::cursors_shown() const
 338 {
 339         return show_cursors_;
 340 }
 341
 342 void View::show_cursors(bool show)
 343 {
 344         show_cursors_ = show;
 345         ruler_->update();
 346         viewport_->update();
 347 }
 348
 349 void View::centre_cursors()
 350 {
 351         const double time_width = scale_ * viewport_->width();
 352         cursors_->first()->set_time(offset_ + time_width * 0.4);
 353         cursors_->second()->set_time(offset_ + time_width * 0.6);
 354         ruler_->update();
 355         viewport_->update();
 356 }
 357
 358 std::shared_ptr<CursorPair> View::cursors() const
 359 {
 360         return cursors_;
 361 }
 362
 363 void View::add_flag(double time)
 364 {
 365         flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
 366                 QString("%1").arg(next_flag_text_))));
 367         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
 368                 (next_flag_text_ + 1);
 369         time_item_appearance_changed(true, true);
 370 }
 371
 372 void View::remove_flag(std::shared_ptr<Flag> flag)
 373 {
 374         flags_.remove(flag);
 375         time_item_appearance_changed(true, true);
 376 }
 377
 378 vector< std::shared_ptr<Flag> > View::flags() const
 379 {
 380         vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
 381         stable_sort(flags.begin(), flags.end(),
 382                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
 383                         return a->time() < b->time();
 384                 });
 385
 386         return flags;
 387 }
 388
 389 const QPoint& View::hover_point() const
 390 {
 391         return hover_point_;
 392 }
 393
 394 void View::update_viewport()
 395 {
 396         assert(viewport_);
 397         viewport_->update();
 398         header_->update();
 399 }
 400
 401 void View::restack_all_row_items()
 402 {
 403         // Make a set of owners
 404         unordered_set< RowItemOwner* > owners;
 405         for (const auto &r : *this)
 406                 owners.insert(r->owner());
 407
 408         // Make a list that is sorted from deepest first
 409         vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
 410         sort(sorted_owners.begin(), sorted_owners.end(),
 411                 [](const RowItemOwner* a, const RowItemOwner *b) {
 412                         return a->depth() > b->depth(); });
 413
 414         // Restack the items recursively
 415         for (auto &o : sorted_owners)
 416                 o->restack_items();
 417
 418         // Animate the items to their destination
 419         for (const auto &r : *this)
 420                 r->animate_to_layout_v_offset();
 421 }
 422
 423 void View::get_scroll_layout(double &length, double &offset) const
 424 {
 425         const pair<double, double> extents = get_time_extents();
 426         length = (extents.second - extents.first) / scale_;
 427         offset = offset_ / scale_;
 428 }
 429
 430 void View::set_zoom(double scale, int offset)
 431 {
 432         const double cursor_offset = offset_ + scale_ * offset;
 433         const double new_scale = max(min(scale, MaxScale), MinScale);
 434         const double new_offset = cursor_offset - new_scale * offset;
 435         set_scale_offset(new_scale, new_offset);
 436 }
 437
 438 void View::calculate_tick_spacing()
 439 {
 440         const double SpacingIncrement = 32.0f;
 441         const double MinValueSpacing = 32.0f;
 442
 443         double min_width = SpacingIncrement, typical_width;
 444
 445         QFontMetrics m(QApplication::font());
 446
 447         do {
 448                 const double min_period = scale_ * min_width;
 449
 450                 const int order = (int)floorf(log10f(min_period));
 451                 const double order_decimal = pow(10.0, order);
 452
 453                 unsigned int unit = 0;
 454
 455                 do {
 456                         tick_period_ = order_decimal * ScaleUnits[unit++];
 457                 } while (tick_period_ < min_period &&
 458                         unit < countof(ScaleUnits));
 459
 460                 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
 461
 462                 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
 463                         Qt::AlignLeft | Qt::AlignTop,
 464                         format_time(offset_, tick_prefix_)).width() +
 465                                 MinValueSpacing;
 466
 467                 min_width += SpacingIncrement;
 468
 469         } while(typical_width > tick_period_ / scale_);
 470 }
 471
 472 void View::update_scroll()
 473 {
 474         assert(viewport_);
 475
 476         const QSize areaSize = viewport_->size();
 477
 478         // Set the horizontal scroll bar
 479         double length = 0, offset = 0;
 480         get_scroll_layout(length, offset);
 481         length = max(length - areaSize.width(), 0.0);
 482
 483         int major_tick_distance = tick_period_ / scale_;
 484
 485         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
 486         horizontalScrollBar()->setSingleStep(major_tick_distance);
 487
 488         updating_scroll_ = true;
 489
 490         if (length < MaxScrollValue) {
 491                 horizontalScrollBar()->setRange(0, length);
 492                 horizontalScrollBar()->setSliderPosition(offset);
 493         } else {
 494                 horizontalScrollBar()->setRange(0, MaxScrollValue);
 495                 horizontalScrollBar()->setSliderPosition(
 496                         offset_ * MaxScrollValue / (scale_ * length));
 497         }
 498
 499         updating_scroll_ = false;
 500
 501         // Set the vertical scrollbar
 502         verticalScrollBar()->setPageStep(areaSize.height());
 503         verticalScrollBar()->setSingleStep(areaSize.height() / 8);
 504
 505         const pair<int, int> extents = v_extents();
 506         verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
 507                 extents.second - (areaSize.height() / 2));
 508 }
 509
 510 void View::update_layout()
 511 {
 512         setViewportMargins(
 513                 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
 514                 ruler_->sizeHint().height(), 0, 0);
 515         ruler_->setGeometry(viewport_->x(), 0,
 516                 viewport_->width(), ruler_->extended_size_hint().height());
 517         header_->setGeometry(0, viewport_->y(),
 518                 header_->extended_size_hint().width(), viewport_->height());
 519         update_scroll();
 520 }
 521
 522 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
 523 {
 524         (void)p;
 525         (void)rect;
 526         (void)hover;
 527 }
 528
 529 QRectF View::label_rect(const QRectF &rect)
 530 {
 531         (void)rect;
 532         return QRectF();
 533 }
 534
 535 bool View::add_channels_to_owner(
 536         const vector< shared_ptr<sigrok::Channel> > &channels,
 537         RowItemOwner *owner, int &offset,
 538         unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
 539                 &signal_map,
 540         std::function<bool (shared_ptr<RowItem>)> filter_func)
 541 {
 542         bool any_added = false;
 543
 544         assert(owner);
 545
 546         for (const auto &channel : channels)
 547         {
 548                 const auto iter = signal_map.find(channel);
 549                 if (iter == signal_map.end() ||
 550                         (filter_func && !filter_func((*iter).second)))
 551                         continue;
 552
 553                 shared_ptr<RowItem> row_item = (*iter).second;
 554                 owner->add_child_item(row_item);
 555                 apply_offset(row_item, offset);
 556                 signal_map.erase(iter);
 557
 558                 any_added = true;
 559         }
 560
 561         return any_added;
 562 }
 563
 564 void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
 565         assert(row_item);
 566         const pair<int, int> extents = row_item->v_extents();
 567         if (row_item->enabled())
 568                 offset += -extents.first;
 569         row_item->force_to_v_offset(offset);
 570         if (row_item->enabled())
 571                 offset += extents.second;
 572 }
 573
 574 bool View::eventFilter(QObject *object, QEvent *event)
 575 {
 576         const QEvent::Type type = event->type();
 577         if (type == QEvent::MouseMove) {
 578
 579                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 580                 if (object == viewport_)
 581                         hover_point_ = mouse_event->pos();
 582                 else if (object == ruler_)
 583                         hover_point_ = QPoint(mouse_event->x(), 0);
 584                 else if (object == header_)
 585                         hover_point_ = QPoint(0, mouse_event->y());
 586                 else
 587                         hover_point_ = QPoint(-1, -1);
 588
 589                 hover_point_changed();
 590
 591         } else if (type == QEvent::Leave) {
 592                 hover_point_ = QPoint(-1, -1);
 593                 hover_point_changed();
 594         }
 595
 596         return QObject::eventFilter(object, event);
 597 }
 598
 599 bool View::viewportEvent(QEvent *e)
 600 {
 601         switch(e->type()) {
 602         case QEvent::Paint:
 603         case QEvent::MouseButtonPress:
 604         case QEvent::MouseButtonRelease:
 605         case QEvent::MouseButtonDblClick:
 606         case QEvent::MouseMove:
 607         case QEvent::Wheel:
 608         case QEvent::TouchBegin:
 609         case QEvent::TouchUpdate:
 610         case QEvent::TouchEnd:
 611                 return false;
 612
 613         default:
 614                 return QAbstractScrollArea::viewportEvent(e);
 615         }
 616 }
 617
 618 void View::resizeEvent(QResizeEvent*)
 619 {
 620         update_layout();
 621 }
 622
 623 void View::row_item_appearance_changed(bool label, bool content)
 624 {
 625         if (label)
 626                 header_->update();
 627         if (content)
 628                 viewport_->update();
 629 }
 630
 631 void View::time_item_appearance_changed(bool label, bool content)
 632 {
 633         if (label)
 634                 ruler_->update();
 635         if (content)
 636                 viewport_->update();
 637 }
 638
 639 void View::extents_changed(bool horz, bool vert)
 640 {
 641         sticky_events_ |=
 642                 (horz ? RowItemHExtentsChanged : 0) |
 643                 (vert ? RowItemVExtentsChanged : 0);
 644         lazy_event_handler_.start();
 645 }
 646
 647 void View::h_scroll_value_changed(int value)
 648 {
 649         if (updating_scroll_)
 650                 return;
 651
 652         const int range = horizontalScrollBar()->maximum();
 653         if (range < MaxScrollValue)
 654                 offset_ = scale_ * value;
 655         else {
 656                 double length = 0, offset;
 657                 get_scroll_layout(length, offset);
 658                 offset_ = scale_ * length * value / MaxScrollValue;
 659         }
 660
 661         ruler_->update();
 662         viewport_->update();
 663 }
 664
 665 void View::v_scroll_value_changed()
 666 {
 667         header_->update();
 668         viewport_->update();
 669 }
 670
 671 void View::signals_changed()
 672 {
 673         int offset = 0;
 674
 675         // Populate the traces
 676         clear_child_items();
 677
 678         shared_ptr<sigrok::Device> device = session_.device();
 679         assert(device);
 680
 681         // Collect a set of signals
 682         unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
 683                 signal_map;
 684
 685         shared_lock<shared_mutex> lock(session_.signals_mutex());
 686         const vector< shared_ptr<Signal> > &sigs(session_.signals());
 687
 688         for (const shared_ptr<Signal> &sig : sigs)
 689                 signal_map[sig->channel()] = sig;
 690
 691         // Populate channel groups
 692         for (auto entry : device->channel_groups())
 693         {
 694                 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
 695
 696                 if (group->channels().size() <= 1)
 697                         continue;
 698
 699                 shared_ptr<TraceGroup> trace_group(new TraceGroup());
 700                 int child_offset = 0;
 701                 if (add_channels_to_owner(group->channels(),
 702                         trace_group.get(), child_offset, signal_map))
 703                 {
 704                         add_child_item(trace_group);
 705                         apply_offset(trace_group, offset);
 706                 }
 707         }
 708
 709         // Add the remaining logic channels
 710         shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
 711         int child_offset = 0;
 712
 713         if (add_channels_to_owner(device->channels(),
 714                 logic_trace_group.get(), child_offset, signal_map,
 715                 [](shared_ptr<RowItem> r) -> bool {
 716                         return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
 717                         }))
 718
 719         {
 720                 add_child_item(logic_trace_group);
 721                 apply_offset(logic_trace_group, offset);
 722         }
 723
 724         // Add the remaining channels
 725         add_channels_to_owner(device->channels(), this, offset, signal_map);
 726         assert(signal_map.empty());
 727
 728         // Add decode signals
 729 #ifdef ENABLE_DECODE
 730         const vector< shared_ptr<DecodeTrace> > decode_sigs(
 731                 session().get_decode_signals());
 732         for (auto s : decode_sigs) {
 733                 add_child_item(s);
 734                 apply_offset(s, offset);
 735         }
 736 #endif
 737
 738         update_layout();
 739 }
 740
 741 void View::data_updated()
 742 {
 743         // Update the scroll bars
 744         update_scroll();
 745
 746         // Repaint the view
 747         viewport_->update();
 748 }
 749
 750 void View::process_sticky_events()
 751 {
 752         if (sticky_events_ & RowItemHExtentsChanged)
 753                 update_layout();
 754         if (sticky_events_ & RowItemVExtentsChanged) {
 755                 restack_all_row_items();
 756                 update_scroll();
 757         }
 758
 759         // Clear the sticky events
 760         sticky_events_ = 0;
 761 }
 762
 763 void View::on_hover_point_changed()
 764 {
 765         for (shared_ptr<RowItem> r : *this)
 766                 r->hover_point_changed();
 767 }
 768
 769 } // namespace view
 770 } // namespace pv