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