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