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 unsigned int View::depth() const
 208 {
 209         return 0;
 210 }
 211
 212 unsigned int View::tick_prefix() const
 213 {
 214         return tick_prefix_;
 215 }
 216
 217 double View::tick_period() const
 218 {
 219         return tick_period_;
 220 }
 221
 222 void View::zoom(double steps)
 223 {
 224         zoom(steps, viewport_->width() / 2);
 225 }
 226
 227 void View::zoom(double steps, int offset)
 228 {
 229         set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
 230 }
 231
 232 void View::zoom_fit()
 233 {
 234         const pair<double, double> extents = get_time_extents();
 235         const double delta = extents.second - extents.first;
 236         if (delta < 1e-12)
 237                 return;
 238
 239         assert(viewport_);
 240         const int w = viewport_->width();
 241         if (w <= 0)
 242                 return;
 243
 244         const double scale = max(min(delta / w, MaxScale), MinScale);
 245         set_scale_offset(scale, extents.first);
 246 }
 247
 248 void View::zoom_one_to_one()
 249 {
 250         using pv::data::SignalData;
 251
 252         // Make a set of all the visible data objects
 253         set< shared_ptr<SignalData> > visible_data = get_visible_data();
 254         if (visible_data.empty())
 255                 return;
 256
 257         double samplerate = 0.0;
 258         for (const shared_ptr<SignalData> d : visible_data) {
 259                 assert(d);
 260                 const vector< shared_ptr<Segment> > segments =
 261                         d->segments();
 262                 for (const shared_ptr<Segment> &s : segments)
 263                         samplerate = max(samplerate, s->samplerate());
 264         }
 265
 266         if (samplerate == 0.0)
 267                 return;
 268
 269         assert(viewport_);
 270         const int w = viewport_->width();
 271         if (w <= 0)
 272                 return;
 273
 274         set_zoom(1.0 / samplerate, w / 2);
 275 }
 276
 277 void View::set_scale_offset(double scale, double offset)
 278 {
 279         scale_ = scale;
 280         offset_ = offset;
 281
 282         calculate_tick_spacing();
 283
 284         update_scroll();
 285         ruler_->update();
 286         viewport_->update();
 287         scale_offset_changed();
 288 }
 289
 290 set< shared_ptr<SignalData> > View::get_visible_data() const
 291 {
 292         shared_lock<shared_mutex> lock(session().signals_mutex());
 293         const vector< shared_ptr<Signal> > &sigs(session().signals());
 294
 295         // Make a set of all the visible data objects
 296         set< shared_ptr<SignalData> > visible_data;
 297         for (const shared_ptr<Signal> sig : sigs)
 298                 if (sig->enabled())
 299                         visible_data.insert(sig->data());
 300
 301         return visible_data;
 302 }
 303
 304 pair<double, double> View::get_time_extents() const
 305 {
 306         double left_time = DBL_MAX, right_time = DBL_MIN;
 307         const set< shared_ptr<SignalData> > visible_data = get_visible_data();
 308         for (const shared_ptr<SignalData> d : visible_data)
 309         {
 310                 const vector< shared_ptr<Segment> > segments =
 311                         d->segments();
 312                 for (const shared_ptr<Segment> &s : segments) {
 313                         double samplerate = s->samplerate();
 314                         samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 315
 316                         const double start_time = s->start_time();
 317                         left_time = min(left_time, start_time);
 318                         right_time = max(right_time, start_time +
 319                                 d->get_max_sample_count() / samplerate);
 320                 }
 321         }
 322
 323         if (left_time == DBL_MAX && right_time == DBL_MIN)
 324                 return make_pair(0.0, 0.0);
 325
 326         assert(left_time < right_time);
 327         return make_pair(left_time, right_time);
 328 }
 329
 330 bool View::cursors_shown() const
 331 {
 332         return show_cursors_;
 333 }
 334
 335 void View::show_cursors(bool show)
 336 {
 337         show_cursors_ = show;
 338         ruler_->update();
 339         viewport_->update();
 340 }
 341
 342 void View::centre_cursors()
 343 {
 344         const double time_width = scale_ * viewport_->width();
 345         cursors_->first()->set_time(offset_ + time_width * 0.4);
 346         cursors_->second()->set_time(offset_ + time_width * 0.6);
 347         ruler_->update();
 348         viewport_->update();
 349 }
 350
 351 std::shared_ptr<CursorPair> View::cursors() const
 352 {
 353         return cursors_;
 354 }
 355
 356 void View::add_flag(double time)
 357 {
 358         flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
 359                 QString("%1").arg(next_flag_text_))));
 360         next_flag_text_ = (next_flag_text_ >= 'Z') ? 'A' :
 361                 (next_flag_text_ + 1);
 362         time_item_appearance_changed(true, true);
 363 }
 364
 365 void View::remove_flag(std::shared_ptr<Flag> flag)
 366 {
 367         flags_.remove(flag);
 368         time_item_appearance_changed(true, true);
 369 }
 370
 371 vector< std::shared_ptr<Flag> > View::flags() const
 372 {
 373         vector< std::shared_ptr<Flag> > flags(flags_.begin(), flags_.end());
 374         stable_sort(flags.begin(), flags.end(),
 375                 [](const shared_ptr<Flag> &a, const shared_ptr<Flag> &b) {
 376                         return a->time() < b->time();
 377                 });
 378
 379         return flags;
 380 }
 381
 382 const QPoint& View::hover_point() const
 383 {
 384         return hover_point_;
 385 }
 386
 387 void View::update_viewport()
 388 {
 389         assert(viewport_);
 390         viewport_->update();
 391         header_->update();
 392 }
 393
 394 void View::restack_all_row_items()
 395 {
 396         // Make a set of owners
 397         unordered_set< RowItemOwner* > owners;
 398         for (const auto &r : *this)
 399                 owners.insert(r->owner());
 400
 401         // Make a list that is sorted from deepest first
 402         vector< RowItemOwner* > sorted_owners(owners.begin(), owners.end());
 403         sort(sorted_owners.begin(), sorted_owners.end(),
 404                 [](const RowItemOwner* a, const RowItemOwner *b) {
 405                         return a->depth() > b->depth(); });
 406
 407         // Restack the items recursively
 408         for (auto &o : sorted_owners)
 409                 o->restack_items();
 410
 411         // Animate the items to their destination
 412         for (const auto &r : *this)
 413                 r->animate_to_layout_v_offset();
 414 }
 415
 416 void View::get_scroll_layout(double &length, double &offset) const
 417 {
 418         const pair<double, double> extents = get_time_extents();
 419         length = (extents.second - extents.first) / scale_;
 420         offset = offset_ / scale_;
 421 }
 422
 423 void View::set_zoom(double scale, int offset)
 424 {
 425         const double cursor_offset = offset_ + scale_ * offset;
 426         const double new_scale = max(min(scale, MaxScale), MinScale);
 427         const double new_offset = cursor_offset - new_scale * offset;
 428         set_scale_offset(new_scale, new_offset);
 429 }
 430
 431 void View::calculate_tick_spacing()
 432 {
 433         const double SpacingIncrement = 32.0f;
 434         const double MinValueSpacing = 32.0f;
 435
 436         double min_width = SpacingIncrement, typical_width;
 437
 438         QFontMetrics m(QApplication::font());
 439
 440         do {
 441                 const double min_period = scale_ * min_width;
 442
 443                 const int order = (int)floorf(log10f(min_period));
 444                 const double order_decimal = pow(10.0, order);
 445
 446                 unsigned int unit = 0;
 447
 448                 do {
 449                         tick_period_ = order_decimal * ScaleUnits[unit++];
 450                 } while (tick_period_ < min_period &&
 451                         unit < countof(ScaleUnits));
 452
 453                 tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
 454
 455                 typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
 456                         Qt::AlignLeft | Qt::AlignTop,
 457                         format_time(offset_, tick_prefix_)).width() +
 458                                 MinValueSpacing;
 459
 460                 min_width += SpacingIncrement;
 461
 462         } while(typical_width > tick_period_ / scale_);
 463 }
 464
 465 void View::update_scroll()
 466 {
 467         assert(viewport_);
 468
 469         const QSize areaSize = viewport_->size();
 470
 471         // Set the horizontal scroll bar
 472         double length = 0, offset = 0;
 473         get_scroll_layout(length, offset);
 474         length = max(length - areaSize.width(), 0.0);
 475
 476         int major_tick_distance = tick_period_ / scale_;
 477
 478         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
 479         horizontalScrollBar()->setSingleStep(major_tick_distance);
 480
 481         updating_scroll_ = true;
 482
 483         if (length < MaxScrollValue) {
 484                 horizontalScrollBar()->setRange(0, length);
 485                 horizontalScrollBar()->setSliderPosition(offset);
 486         } else {
 487                 horizontalScrollBar()->setRange(0, MaxScrollValue);
 488                 horizontalScrollBar()->setSliderPosition(
 489                         offset_ * MaxScrollValue / (scale_ * length));
 490         }
 491
 492         updating_scroll_ = false;
 493
 494         // Set the vertical scrollbar
 495         verticalScrollBar()->setPageStep(areaSize.height());
 496         verticalScrollBar()->setSingleStep(areaSize.height() / 8);
 497
 498         const pair<int, int> extents = v_extents();
 499         verticalScrollBar()->setRange(extents.first - (areaSize.height() / 2),
 500                 extents.second - (areaSize.height() / 2));
 501 }
 502
 503 void View::update_layout()
 504 {
 505         setViewportMargins(
 506                 header_->sizeHint().width() - pv::view::Header::BaselineOffset,
 507                 ruler_->sizeHint().height(), 0, 0);
 508         ruler_->setGeometry(viewport_->x(), 0,
 509                 viewport_->width(), ruler_->extended_size_hint().height());
 510         header_->setGeometry(0, viewport_->y(),
 511                 header_->extended_size_hint().width(), viewport_->height());
 512         update_scroll();
 513 }
 514
 515 void View::paint_label(QPainter &p, const QRect &rect, bool hover)
 516 {
 517         (void)p;
 518         (void)rect;
 519         (void)hover;
 520 }
 521
 522 QRectF View::label_rect(const QRectF &rect)
 523 {
 524         (void)rect;
 525         return QRectF();
 526 }
 527
 528 bool View::add_channels_to_owner(
 529         const vector< shared_ptr<sigrok::Channel> > &channels,
 530         RowItemOwner *owner, int &offset,
 531         unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
 532                 &signal_map,
 533         std::function<bool (shared_ptr<RowItem>)> filter_func)
 534 {
 535         bool any_added = false;
 536
 537         assert(owner);
 538
 539         for (const auto &channel : channels)
 540         {
 541                 const auto iter = signal_map.find(channel);
 542                 if (iter == signal_map.end() ||
 543                         (filter_func && !filter_func((*iter).second)))
 544                         continue;
 545
 546                 shared_ptr<RowItem> row_item = (*iter).second;
 547                 owner->add_child_item(row_item);
 548                 apply_offset(row_item, offset);
 549                 signal_map.erase(iter);
 550
 551                 any_added = true;
 552         }
 553
 554         return any_added;
 555 }
 556
 557 void View::apply_offset(shared_ptr<RowItem> row_item, int &offset) {
 558         assert(row_item);
 559         const pair<int, int> extents = row_item->v_extents();
 560         if (row_item->enabled())
 561                 offset += -extents.first;
 562         row_item->force_to_v_offset(offset);
 563         if (row_item->enabled())
 564                 offset += extents.second;
 565 }
 566
 567 bool View::eventFilter(QObject *object, QEvent *event)
 568 {
 569         const QEvent::Type type = event->type();
 570         if (type == QEvent::MouseMove) {
 571
 572                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 573                 if (object == viewport_)
 574                         hover_point_ = mouse_event->pos();
 575                 else if (object == ruler_)
 576                         hover_point_ = QPoint(mouse_event->x(), 0);
 577                 else if (object == header_)
 578                         hover_point_ = QPoint(0, mouse_event->y());
 579                 else
 580                         hover_point_ = QPoint(-1, -1);
 581
 582                 hover_point_changed();
 583
 584         } else if (type == QEvent::Leave) {
 585                 hover_point_ = QPoint(-1, -1);
 586                 hover_point_changed();
 587         }
 588
 589         return QObject::eventFilter(object, event);
 590 }
 591
 592 bool View::viewportEvent(QEvent *e)
 593 {
 594         switch(e->type()) {
 595         case QEvent::Paint:
 596         case QEvent::MouseButtonPress:
 597         case QEvent::MouseButtonRelease:
 598         case QEvent::MouseButtonDblClick:
 599         case QEvent::MouseMove:
 600         case QEvent::Wheel:
 601         case QEvent::TouchBegin:
 602         case QEvent::TouchUpdate:
 603         case QEvent::TouchEnd:
 604                 return false;
 605
 606         default:
 607                 return QAbstractScrollArea::viewportEvent(e);
 608         }
 609 }
 610
 611 void View::resizeEvent(QResizeEvent*)
 612 {
 613         update_layout();
 614 }
 615
 616 void View::row_item_appearance_changed(bool label, bool content)
 617 {
 618         if (label)
 619                 header_->update();
 620         if (content)
 621                 viewport_->update();
 622 }
 623
 624 void View::time_item_appearance_changed(bool label, bool content)
 625 {
 626         if (label)
 627                 ruler_->update();
 628         if (content)
 629                 viewport_->update();
 630 }
 631
 632 void View::extents_changed(bool horz, bool vert)
 633 {
 634         sticky_events_ |=
 635                 (horz ? RowItemHExtentsChanged : 0) |
 636                 (vert ? RowItemVExtentsChanged : 0);
 637         lazy_event_handler_.start();
 638 }
 639
 640 void View::h_scroll_value_changed(int value)
 641 {
 642         if (updating_scroll_)
 643                 return;
 644
 645         const int range = horizontalScrollBar()->maximum();
 646         if (range < MaxScrollValue)
 647                 offset_ = scale_ * value;
 648         else {
 649                 double length = 0, offset;
 650                 get_scroll_layout(length, offset);
 651                 offset_ = scale_ * length * value / MaxScrollValue;
 652         }
 653
 654         ruler_->update();
 655         viewport_->update();
 656 }
 657
 658 void View::v_scroll_value_changed()
 659 {
 660         header_->update();
 661         viewport_->update();
 662 }
 663
 664 void View::signals_changed()
 665 {
 666         int offset = 0;
 667
 668         // Populate the traces
 669         clear_child_items();
 670
 671         shared_ptr<sigrok::Device> device = session_.device();
 672         assert(device);
 673
 674         // Collect a set of signals
 675         unordered_map<shared_ptr<sigrok::Channel>, shared_ptr<Signal> >
 676                 signal_map;
 677
 678         shared_lock<shared_mutex> lock(session_.signals_mutex());
 679         const vector< shared_ptr<Signal> > &sigs(session_.signals());
 680
 681         for (const shared_ptr<Signal> &sig : sigs)
 682                 signal_map[sig->channel()] = sig;
 683
 684         // Populate channel groups
 685         for (auto entry : device->channel_groups())
 686         {
 687                 const shared_ptr<sigrok::ChannelGroup> &group = entry.second;
 688
 689                 if (group->channels().size() <= 1)
 690                         continue;
 691
 692                 shared_ptr<TraceGroup> trace_group(new TraceGroup());
 693                 int child_offset = 0;
 694                 if (add_channels_to_owner(group->channels(),
 695                         trace_group.get(), child_offset, signal_map))
 696                 {
 697                         add_child_item(trace_group);
 698                         apply_offset(trace_group, offset);
 699                 }
 700         }
 701
 702         // Add the remaining logic channels
 703         shared_ptr<TraceGroup> logic_trace_group(new TraceGroup());
 704         int child_offset = 0;
 705
 706         if (add_channels_to_owner(device->channels(),
 707                 logic_trace_group.get(), child_offset, signal_map,
 708                 [](shared_ptr<RowItem> r) -> bool {
 709                         return dynamic_pointer_cast<LogicSignal>(r) != nullptr;
 710                         }))
 711
 712         {
 713                 add_child_item(logic_trace_group);
 714                 apply_offset(logic_trace_group, offset);
 715         }
 716
 717         // Add the remaining channels
 718         add_channels_to_owner(device->channels(), this, offset, signal_map);
 719         assert(signal_map.empty());
 720
 721         // Add decode signals
 722 #ifdef ENABLE_DECODE
 723         const vector< shared_ptr<DecodeTrace> > decode_sigs(
 724                 session().get_decode_signals());
 725         for (auto s : decode_sigs) {
 726                 add_child_item(s);
 727                 apply_offset(s, offset);
 728         }
 729 #endif
 730
 731         update_layout();
 732 }
 733
 734 void View::data_updated()
 735 {
 736         // Update the scroll bars
 737         update_scroll();
 738
 739         // Repaint the view
 740         viewport_->update();
 741 }
 742
 743 void View::process_sticky_events()
 744 {
 745         if (sticky_events_ & RowItemHExtentsChanged)
 746                 update_layout();
 747         if (sticky_events_ & RowItemVExtentsChanged) {
 748                 restack_all_row_items();
 749                 update_scroll();
 750         }
 751
 752         // Clear the sticky events
 753         sticky_events_ = 0;
 754 }
 755
 756 void View::on_hover_point_changed()
 757 {
 758         for (shared_ptr<RowItem> r : *this)
 759                 r->hover_point_changed();
 760 }
 761
 762 } // namespace view
 763 } // namespace pv