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 <cassert>
  26 #include <climits>
  27 #include <cmath>
  28 #include <mutex>
  29
  30 #include <QEvent>
  31 #include <QMouseEvent>
  32 #include <QScrollBar>
  33
  34 #include "cursorheader.h"
  35 #include "decodetrace.h"
  36 #include "header.h"
  37 #include "ruler.h"
  38 #include "signal.h"
  39 #include "view.h"
  40 #include "viewport.h"
  41
  42 #include "pv/sigsession.h"
  43 #include "pv/data/logic.h"
  44 #include "pv/data/logicsnapshot.h"
  45
  46 using boost::shared_lock;
  47 using boost::shared_mutex;
  48 using pv::data::SignalData;
  49 using std::back_inserter;
  50 using std::deque;
  51 using std::list;
  52 using std::lock_guard;
  53 using std::max;
  54 using std::make_pair;
  55 using std::min;
  56 using std::pair;
  57 using std::set;
  58 using std::shared_ptr;
  59 using std::vector;
  60 using std::weak_ptr;
  61
  62 namespace pv {
  63 namespace view {
  64
  65 const double View::MaxScale = 1e9;
  66 const double View::MinScale = 1e-15;
  67
  68 const int View::MaxScrollValue = INT_MAX / 2;
  69
  70 const int View::SignalHeight = 30;
  71 const int View::SignalMargin = 10;
  72 const int View::SignalSnapGridSize = 10;
  73
  74 const QColor View::CursorAreaColour(220, 231, 243);
  75
  76 const QSizeF View::LabelPadding(4, 0);
  77
  78 View::View(SigSession &session, QWidget *parent) :
  79         QAbstractScrollArea(parent),
  80         _session(session),
  81         _viewport(new Viewport(*this)),
  82         _ruler(new Ruler(*this)),
  83         _cursorheader(new CursorHeader(*this)),
  84         _header(new Header(*this)),
  85         _scale(1e-6),
  86         _offset(0),
  87         _v_offset(0),
  88         _updating_scroll(false),
  89         _show_cursors(false),
  90         _cursors(*this),
  91         _hover_point(-1, -1)
  92 {
  93         connect(horizontalScrollBar(), SIGNAL(valueChanged(int)),
  94                 this, SLOT(h_scroll_value_changed(int)));
  95         connect(verticalScrollBar(), SIGNAL(valueChanged(int)),
  96                 this, SLOT(v_scroll_value_changed(int)));
  97
  98         connect(&_session, SIGNAL(signals_changed()),
  99                 this, SLOT(signals_changed()));
 100         connect(&_session, SIGNAL(capture_state_changed(int)),
 101                 this, SLOT(data_updated()));
 102         connect(&_session, SIGNAL(data_received()),
 103                 this, SLOT(data_updated()));
 104         connect(&_session, SIGNAL(frame_ended()),
 105                 this, SLOT(data_updated()));
 106
 107         connect(_cursors.first().get(), SIGNAL(time_changed()),
 108                 this, SLOT(marker_time_changed()));
 109         connect(_cursors.second().get(), SIGNAL(time_changed()),
 110                 this, SLOT(marker_time_changed()));
 111
 112         connect(_header, SIGNAL(geometry_updated()),
 113                 this, SLOT(on_geometry_updated()));
 114         connect(_header, SIGNAL(signals_moved()),
 115                 this, SLOT(on_signals_moved()));
 116
 117         connect(_header, SIGNAL(selection_changed()),
 118                 _cursorheader, SLOT(clear_selection()));
 119         connect(_cursorheader, SIGNAL(selection_changed()),
 120                 _header, SLOT(clear_selection()));
 121
 122         connect(_header, SIGNAL(selection_changed()),
 123                 this, SIGNAL(selection_changed()));
 124         connect(_cursorheader, 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         setViewport(_viewport);
 131
 132         _viewport->installEventFilter(this);
 133         _ruler->installEventFilter(this);
 134         _cursorheader->installEventFilter(this);
 135         _header->installEventFilter(this);
 136
 137         // Trigger the initial event manually. The default device has signals
 138         // which were created before this object came into being
 139         signals_changed();
 140
 141         // make sure the transparent widgets are on the top
 142         _cursorheader->raise();
 143         _header->raise();
 144 }
 145
 146 SigSession& View::session()
 147 {
 148         return _session;
 149 }
 150
 151 const SigSession& View::session() const
 152 {
 153         return _session;
 154 }
 155
 156 View* View::view()
 157 {
 158         return this;
 159 }
 160
 161 const View* View::view() const
 162 {
 163         return this;
 164 }
 165
 166 Viewport* View::viewport()
 167 {
 168         return _viewport;
 169 }
 170
 171 const Viewport* View::viewport() const
 172 {
 173         return _viewport;
 174 }
 175
 176 double View::scale() const
 177 {
 178         return _scale;
 179 }
 180
 181 double View::offset() const
 182 {
 183         return _offset;
 184 }
 185
 186 int View::owner_v_offset() const
 187 {
 188         return -_v_offset;
 189 }
 190
 191 void View::zoom(double steps)
 192 {
 193         zoom(steps, _viewport->width() / 2);
 194 }
 195
 196 void View::zoom(double steps, int offset)
 197 {
 198         set_zoom(_scale * pow(3.0/2.0, -steps), offset);
 199 }
 200
 201 void View::zoom_fit()
 202 {
 203         const pair<double, double> extents = get_time_extents();
 204         const double delta = extents.second - extents.first;
 205         if (delta < 1e-12)
 206                 return;
 207
 208         assert(_viewport);
 209         const int w = _viewport->width();
 210         if (w <= 0)
 211                 return;
 212
 213         const double scale = max(min(delta / w, MaxScale), MinScale);
 214         set_scale_offset(scale, extents.first);
 215 }
 216
 217 void View::zoom_one_to_one()
 218 {
 219         using pv::data::SignalData;
 220
 221         // Make a set of all the visible data objects
 222         set< shared_ptr<SignalData> > visible_data = get_visible_data();
 223         if (visible_data.empty())
 224                 return;
 225
 226         double samplerate = 0.0;
 227         for (const shared_ptr<SignalData> d : visible_data) {
 228                 assert(d);
 229                 samplerate = max(samplerate, d->samplerate());
 230         }
 231
 232         if (samplerate == 0.0)
 233                 return;
 234
 235         assert(_viewport);
 236         const int w = _viewport->width();
 237         if (w <= 0)
 238                 return;
 239
 240         set_zoom(1.0 / samplerate, w / 2);
 241 }
 242
 243 void View::set_scale_offset(double scale, double offset)
 244 {
 245         _scale = scale;
 246         _offset = offset;
 247
 248         update_scroll();
 249         _ruler->update();
 250         _cursorheader->update();
 251         _viewport->update();
 252         scale_offset_changed();
 253 }
 254
 255 list<weak_ptr<SelectableItem> > View::selected_items() const
 256 {
 257         list<weak_ptr<SelectableItem> > items;
 258
 259         // List the selected signals
 260         const vector< shared_ptr<RowItem> > row_items(child_items());
 261         for (shared_ptr<RowItem> r : row_items) {
 262                 if (r && r->selected())
 263                         items.push_back(r);
 264         }
 265
 266         // List the selected cursors
 267         if (_cursors.first()->selected())
 268                 items.push_back(_cursors.first());
 269         if (_cursors.second()->selected())
 270                 items.push_back(_cursors.second());
 271
 272         return items;
 273 }
 274
 275 set< shared_ptr<SignalData> > View::get_visible_data() const
 276 {
 277         shared_lock<shared_mutex> lock(session().signals_mutex());
 278         const vector< shared_ptr<Signal> > &sigs(session().signals());
 279
 280         // Make a set of all the visible data objects
 281         set< shared_ptr<SignalData> > visible_data;
 282         for (const shared_ptr<Signal> sig : sigs)
 283                 if (sig->enabled())
 284                         visible_data.insert(sig->data());
 285
 286         return visible_data;
 287 }
 288
 289 pair<double, double> View::get_time_extents() const
 290 {
 291         const set< shared_ptr<SignalData> > visible_data = get_visible_data();
 292         if (visible_data.empty())
 293                 return make_pair(0.0, 0.0);
 294
 295         double left_time = DBL_MAX, right_time = DBL_MIN;
 296         for (const shared_ptr<SignalData> d : visible_data)
 297         {
 298                 const double start_time = d->get_start_time();
 299                 double samplerate = d->samplerate();
 300                 samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 301
 302                 left_time = min(left_time, start_time);
 303                 right_time = max(right_time, start_time +
 304                         d->get_max_sample_count() / samplerate);
 305         }
 306
 307         assert(left_time < right_time);
 308         return make_pair(left_time, right_time);
 309 }
 310
 311 bool View::cursors_shown() const
 312 {
 313         return _show_cursors;
 314 }
 315
 316 void View::show_cursors(bool show)
 317 {
 318         _show_cursors = show;
 319         _cursorheader->update();
 320         _viewport->update();
 321 }
 322
 323 void View::centre_cursors()
 324 {
 325         const double time_width = _scale * _viewport->width();
 326         _cursors.first()->set_time(_offset + time_width * 0.4);
 327         _cursors.second()->set_time(_offset + time_width * 0.6);
 328         _cursorheader->update();
 329         _viewport->update();
 330 }
 331
 332 CursorPair& View::cursors()
 333 {
 334         return _cursors;
 335 }
 336
 337 const CursorPair& View::cursors() const
 338 {
 339         return _cursors;
 340 }
 341
 342 const QPoint& View::hover_point() const
 343 {
 344         return _hover_point;
 345 }
 346
 347 void View::normalize_layout()
 348 {
 349         const vector< shared_ptr<RowItem> > row_items(child_items());
 350
 351         int v_min = INT_MAX;
 352         for (const shared_ptr<RowItem> r : row_items)
 353                 v_min = min(r->v_offset(), v_min);
 354
 355         const int delta = -min(v_min, 0);
 356         for (shared_ptr<RowItem> r : row_items)
 357                 r->set_v_offset(r->v_offset() + delta);
 358
 359         verticalScrollBar()->setSliderPosition(_v_offset + delta);
 360         v_scroll_value_changed(verticalScrollBar()->sliderPosition());
 361 }
 362
 363 void View::update_viewport()
 364 {
 365         assert(_viewport);
 366         _viewport->update();
 367 }
 368
 369 void View::get_scroll_layout(double &length, double &offset) const
 370 {
 371         const pair<double, double> extents = get_time_extents();
 372         length = (extents.second - extents.first) / _scale;
 373         offset = _offset / _scale;
 374 }
 375
 376 void View::set_zoom(double scale, int offset)
 377 {
 378         const double cursor_offset = _offset + _scale * offset;
 379         const double new_scale = max(min(scale, MaxScale), MinScale);
 380         const double new_offset = cursor_offset - new_scale * offset;
 381         set_scale_offset(new_scale, new_offset);
 382 }
 383
 384 void View::update_scroll()
 385 {
 386         assert(_viewport);
 387
 388         const QSize areaSize = _viewport->size();
 389
 390         // Set the horizontal scroll bar
 391         double length = 0, offset = 0;
 392         get_scroll_layout(length, offset);
 393         length = max(length - areaSize.width(), 0.0);
 394
 395         horizontalScrollBar()->setPageStep(areaSize.width() / 2);
 396
 397         _updating_scroll = true;
 398
 399         if (length < MaxScrollValue) {
 400                 horizontalScrollBar()->setRange(0, length);
 401                 horizontalScrollBar()->setSliderPosition(offset);
 402         } else {
 403                 horizontalScrollBar()->setRange(0, MaxScrollValue);
 404                 horizontalScrollBar()->setSliderPosition(
 405                         _offset * MaxScrollValue / (_scale * length));
 406         }
 407
 408         _updating_scroll = false;
 409
 410         // Set the vertical scrollbar
 411         verticalScrollBar()->setPageStep(areaSize.height());
 412         verticalScrollBar()->setRange(0,
 413                 _viewport->get_total_height() + SignalMargin -
 414                 areaSize.height());
 415 }
 416
 417 void View::update_layout()
 418 {
 419         setViewportMargins(
 420                 _header->sizeHint().width() - pv::view::Header::BaselineOffset,
 421                 _ruler->sizeHint().height(), 0, 0);
 422         _ruler->setGeometry(_viewport->x(), 0,
 423                 _viewport->width(), _viewport->y());
 424         _cursorheader->setGeometry(
 425                 _viewport->x(),
 426                 _ruler->sizeHint().height() - _cursorheader->sizeHint().height() / 2,
 427                 _viewport->width(), _cursorheader->sizeHint().height());
 428         _header->setGeometry(0, _viewport->y(),
 429                 _header->sizeHint().width(), _viewport->height());
 430         update_scroll();
 431 }
 432
 433 void View::paint_label(QPainter &p, int right, bool hover)
 434 {
 435         (void)p;
 436         (void)right;
 437         (void)hover;
 438 }
 439
 440 QRectF View::label_rect(int right)
 441 {
 442         (void)right;
 443         return QRectF();
 444 }
 445
 446 bool View::eventFilter(QObject *object, QEvent *event)
 447 {
 448         const QEvent::Type type = event->type();
 449         if (type == QEvent::MouseMove) {
 450
 451                 const QMouseEvent *const mouse_event = (QMouseEvent*)event;
 452                 if (object == _viewport)
 453                         _hover_point = mouse_event->pos();
 454                 else if (object == _ruler || object == _cursorheader)
 455                         _hover_point = QPoint(mouse_event->x(), 0);
 456                 else if (object == _header)
 457                         _hover_point = QPoint(0, mouse_event->y());
 458                 else
 459                         _hover_point = QPoint(-1, -1);
 460
 461                 hover_point_changed();
 462
 463         } else if (type == QEvent::Leave) {
 464                 _hover_point = QPoint(-1, -1);
 465                 hover_point_changed();
 466         }
 467
 468         return QObject::eventFilter(object, event);
 469 }
 470
 471 bool View::viewportEvent(QEvent *e)
 472 {
 473         switch(e->type()) {
 474         case QEvent::Paint:
 475         case QEvent::MouseButtonPress:
 476         case QEvent::MouseButtonRelease:
 477         case QEvent::MouseButtonDblClick:
 478         case QEvent::MouseMove:
 479         case QEvent::Wheel:
 480         case QEvent::TouchBegin:
 481         case QEvent::TouchUpdate:
 482         case QEvent::TouchEnd:
 483                 return false;
 484
 485         default:
 486                 return QAbstractScrollArea::viewportEvent(e);
 487         }
 488 }
 489
 490 void View::resizeEvent(QResizeEvent*)
 491 {
 492         update_layout();
 493 }
 494
 495 void View::h_scroll_value_changed(int value)
 496 {
 497         if (_updating_scroll)
 498                 return;
 499
 500         const int range = horizontalScrollBar()->maximum();
 501         if (range < MaxScrollValue)
 502                 _offset = _scale * value;
 503         else {
 504                 double length = 0, offset;
 505                 get_scroll_layout(length, offset);
 506                 _offset = _scale * length * value / MaxScrollValue;
 507         }
 508
 509         _ruler->update();
 510         _cursorheader->update();
 511         _viewport->update();
 512 }
 513
 514 void View::v_scroll_value_changed(int value)
 515 {
 516         _v_offset = value;
 517         _header->update();
 518         _viewport->update();
 519 }
 520
 521 void View::signals_changed()
 522 {
 523         // Populate the traces
 524         clear_child_items();
 525
 526         shared_lock<shared_mutex> lock(session().signals_mutex());
 527         const vector< shared_ptr<Signal> > &sigs(session().signals());
 528         for (auto s : sigs)
 529                 add_child_item(s);
 530
 531 #ifdef ENABLE_DECODE
 532         const vector< shared_ptr<DecodeTrace> > decode_sigs(
 533                 session().get_decode_signals());
 534         for (auto s : decode_sigs)
 535                 add_child_item(s);
 536 #endif
 537
 538         // Create the initial layout
 539         int offset = SignalMargin + SignalHeight;
 540         for (shared_ptr<RowItem> r : child_items()) {
 541                 r->set_v_offset(offset);
 542                 offset += SignalHeight + 2 * SignalMargin;
 543         }
 544
 545         update_layout();
 546         normalize_layout();
 547 }
 548
 549 void View::data_updated()
 550 {
 551         // Update the scroll bars
 552         update_scroll();
 553
 554         // Repaint the view
 555         _viewport->update();
 556 }
 557
 558 void View::marker_time_changed()
 559 {
 560         _cursorheader->update();
 561         _viewport->update();
 562 }
 563
 564 void View::on_signals_moved()
 565 {
 566         update_scroll();
 567         signals_moved();
 568 }
 569
 570 void View::on_geometry_updated()
 571 {
 572         update_layout();
 573 }
 574
 575 void View::on_hover_point_changed()
 576 {
 577         const vector< shared_ptr<RowItem> > row_items(child_items());
 578         for (shared_ptr<RowItem> r : row_items)
 579                 r->hover_point_changed();
 580 }
 581
 582 } // namespace view
 583 } // namespace pv