pv/view/analogsignal.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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <extdef.h>
  21
  22 #include <cassert>
  23 #include <cmath>
  24 #include <cstdlib>
  25 #include <limits>
  26
  27 #include <QApplication>
  28 #include <QCheckBox>
  29 #include <QComboBox>
  30 #include <QFormLayout>
  31 #include <QGridLayout>
  32 #include <QLabel>
  33 #include <QSpinBox>
  34 #include <QString>
  35
  36 #include "analogsignal.hpp"
  37 #include "pv/data/analog.hpp"
  38 #include "pv/data/analogsegment.hpp"
  39 #include "pv/data/signalbase.hpp"
  40 #include "pv/view/view.hpp"
  41
  42 #include <libsigrokcxx/libsigrokcxx.hpp>
  43
  44 using std::max;
  45 using std::make_pair;
  46 using std::min;
  47 using std::shared_ptr;
  48 using std::deque;
  49
  50 namespace pv {
  51 namespace views {
  52 namespace TraceView {
  53
  54 const QColor AnalogSignal::SignalColours[4] = {
  55         QColor(0xC4, 0xA0, 0x00),       // Yellow
  56         QColor(0x87, 0x20, 0x7A),       // Magenta
  57         QColor(0x20, 0x4A, 0x87),       // Blue
  58         QColor(0x4E, 0x9A, 0x06)        // Green
  59 };
  60
  61 const QColor AnalogSignal::GridMajorColor = QColor(0, 0, 0, 40*256/100);
  62 const QColor AnalogSignal::GridMinorColor = QColor(0, 0, 0, 20*256/100);
  63
  64 const float AnalogSignal::EnvelopeThreshold = 256.0f;
  65
  66 const int AnalogSignal::MaximumVDivs = 10;
  67 const int AnalogSignal::MinScaleIndex = -6;
  68 const int AnalogSignal::MaxScaleIndex = 7;
  69
  70 const int AnalogSignal::InfoTextMarginRight = 20;
  71 const int AnalogSignal::InfoTextMarginBottom = 5;
  72
  73 AnalogSignal::AnalogSignal(
  74         pv::Session &session,
  75         shared_ptr<data::SignalBase> base) :
  76         Signal(session, base),
  77         scale_index_(4), // 20 per div
  78         scale_index_drag_offset_(0),
  79         div_height_(3 * QFontMetrics(QApplication::font()).height()),
  80         pos_vdivs_(1),
  81         neg_vdivs_(1),
  82         resolution_(0),
  83         autoranging_(1)
  84 {
  85         base_->set_colour(SignalColours[base_->index() % countof(SignalColours)]);
  86         update_scale();
  87 }
  88
  89 shared_ptr<pv::data::SignalData> AnalogSignal::data() const
  90 {
  91         return base_->analog_data();
  92 }
  93
  94 void AnalogSignal::save_settings(QSettings &settings) const
  95 {
  96         settings.setValue("pos_vdivs", pos_vdivs_);
  97         settings.setValue("neg_vdivs", neg_vdivs_);
  98         settings.setValue("scale_index", scale_index_);
  99         settings.setValue("autoranging", autoranging_);
 100 }
 101
 102 void AnalogSignal::restore_settings(QSettings &settings)
 103 {
 104         if (settings.contains("pos_vdivs"))
 105                 pos_vdivs_ = settings.value("pos_vdivs").toInt();
 106
 107         if (settings.contains("neg_vdivs"))
 108                 neg_vdivs_ = settings.value("neg_vdivs").toInt();
 109
 110         if (settings.contains("scale_index")) {
 111                 scale_index_ = settings.value("scale_index").toInt();
 112                 update_scale();
 113         }
 114
 115         if (settings.contains("autoranging"))
 116                 autoranging_ = settings.value("autoranging").toBool();
 117 }
 118
 119 std::pair<int, int> AnalogSignal::v_extents() const
 120 {
 121         const int ph = pos_vdivs_ * div_height_;
 122         const int nh = neg_vdivs_ * div_height_;
 123         return make_pair(-ph, nh);
 124 }
 125
 126 int AnalogSignal::scale_handle_offset() const
 127 {
 128         const int h = (pos_vdivs_ + neg_vdivs_) * div_height_;
 129
 130         return ((scale_index_drag_offset_ - scale_index_) *
 131                 h / 4) - h / 2;
 132 }
 133
 134 void AnalogSignal::scale_handle_dragged(int offset)
 135 {
 136         const int h = (pos_vdivs_ + neg_vdivs_) * div_height_;
 137
 138         scale_index_ = scale_index_drag_offset_ -
 139                 (offset + h / 2) / (h / 4);
 140
 141         update_scale();
 142 }
 143
 144 void AnalogSignal::scale_handle_drag_release()
 145 {
 146         scale_index_drag_offset_ = scale_index_;
 147         update_scale();
 148 }
 149
 150 void AnalogSignal::paint_back(QPainter &p, const ViewItemPaintParams &pp)
 151 {
 152         if (base_->enabled()) {
 153                 Trace::paint_back(p, pp);
 154                 paint_axis(p, pp, get_visual_y());
 155         }
 156 }
 157
 158 void AnalogSignal::paint_mid(QPainter &p, const ViewItemPaintParams &pp)
 159 {
 160         assert(base_->analog_data());
 161         assert(owner_);
 162
 163         const int y = get_visual_y();
 164
 165         if (!base_->enabled())
 166                 return;
 167
 168         paint_grid(p, y, pp.left(), pp.right());
 169
 170         const deque< shared_ptr<pv::data::AnalogSegment> > &segments =
 171                 base_->analog_data()->analog_segments();
 172         if (segments.empty())
 173                 return;
 174
 175         const shared_ptr<pv::data::AnalogSegment> &segment =
 176                 segments.front();
 177
 178         const double pixels_offset = pp.pixels_offset();
 179         const double samplerate = max(1.0, segment->samplerate());
 180         const pv::util::Timestamp& start_time = segment->start_time();
 181         const int64_t last_sample = segment->get_sample_count() - 1;
 182         const double samples_per_pixel = samplerate * pp.scale();
 183         const pv::util::Timestamp start = samplerate * (pp.offset() - start_time);
 184         const pv::util::Timestamp end = start + samples_per_pixel * pp.width();
 185
 186         const int64_t start_sample = min(max(floor(start).convert_to<int64_t>(),
 187                 (int64_t)0), last_sample);
 188         const int64_t end_sample = min(max((ceil(end) + 1).convert_to<int64_t>(),
 189                 (int64_t)0), last_sample);
 190
 191         if (samples_per_pixel < EnvelopeThreshold)
 192                 paint_trace(p, segment, y, pp.left(),
 193                         start_sample, end_sample,
 194                         pixels_offset, samples_per_pixel);
 195         else
 196                 paint_envelope(p, segment, y, pp.left(),
 197                         start_sample, end_sample,
 198                         pixels_offset, samples_per_pixel);
 199 }
 200
 201 void AnalogSignal::paint_fore(QPainter &p, const ViewItemPaintParams &pp)
 202 {
 203         if (!enabled())
 204                 return;
 205
 206         const int y = get_visual_y();
 207
 208         // Show the info section on the right side of the trace
 209         const QString infotext = QString("%1 V/div").arg(resolution_);
 210
 211         p.setPen(base_->colour());
 212         p.setFont(QApplication::font());
 213
 214         const QRectF bounding_rect = QRectF(pp.left(),
 215                         y + v_extents().first,
 216                         pp.width() - InfoTextMarginRight,
 217                         v_extents().second - v_extents().first - InfoTextMarginBottom);
 218
 219         p.drawText(bounding_rect, Qt::AlignRight | Qt::AlignBottom, infotext);
 220 }
 221
 222 void AnalogSignal::paint_grid(QPainter &p, int y, int left, int right)
 223 {
 224         p.setRenderHint(QPainter::Antialiasing, false);
 225
 226         if (pos_vdivs_ > 0) {
 227                 p.setPen(QPen(GridMajorColor, 1, Qt::DashLine));
 228                 for (int i = 1; i <= pos_vdivs_; i++) {
 229                         const float dy = i * div_height_;
 230                         p.drawLine(QLineF(left, y - dy, right, y - dy));
 231                 }
 232
 233                 p.setPen(QPen(GridMinorColor, 1, Qt::DashLine));
 234                 for (int i = 0; i < pos_vdivs_; i++) {
 235                         const float dy = i * div_height_;
 236                         const float dy25 = dy + (0.25 * div_height_);
 237                         const float dy50 = dy + (0.50 * div_height_);
 238                         const float dy75 = dy + (0.75 * div_height_);
 239                         p.drawLine(QLineF(left, y - dy25, right, y - dy25));
 240                         p.drawLine(QLineF(left, y - dy50, right, y - dy50));
 241                         p.drawLine(QLineF(left, y - dy75, right, y - dy75));
 242                 }
 243         }
 244
 245         if (neg_vdivs_ > 0) {
 246                 p.setPen(QPen(GridMajorColor, 1, Qt::DashLine));
 247                 for (int i = 1; i <= neg_vdivs_; i++) {
 248                         const float dy = i * div_height_;
 249                         p.drawLine(QLineF(left, y + dy, right, y + dy));
 250                 }
 251
 252                 p.setPen(QPen(GridMinorColor, 1, Qt::DashLine));
 253                 for (int i = 0; i < neg_vdivs_; i++) {
 254                         const float dy = i * div_height_;
 255                         const float dy25 = dy + (0.25 * div_height_);
 256                         const float dy50 = dy + (0.50 * div_height_);
 257                         const float dy75 = dy + (0.75 * div_height_);
 258                         p.drawLine(QLineF(left, y + dy25, right, y + dy25));
 259                         p.drawLine(QLineF(left, y + dy50, right, y + dy50));
 260                         p.drawLine(QLineF(left, y + dy75, right, y + dy75));
 261                 }
 262         }
 263
 264         p.setRenderHint(QPainter::Antialiasing, true);
 265 }
 266
 267 void AnalogSignal::paint_trace(QPainter &p,
 268         const shared_ptr<pv::data::AnalogSegment> &segment,
 269         int y, int left, const int64_t start, const int64_t end,
 270         const double pixels_offset, const double samples_per_pixel)
 271 {
 272         p.setPen(base_->colour());
 273
 274         QPointF *points = new QPointF[end - start];
 275         QPointF *point = points;
 276
 277         pv::data::SegmentAnalogDataIterator* it =
 278                 segment->begin_sample_iteration(start);
 279
 280         for (int64_t sample = start; sample != end; sample++) {
 281                 const float x = (sample / samples_per_pixel -
 282                         pixels_offset) + left;
 283
 284                 *point++ = QPointF(x, y - *((float*)it->value) * scale_);
 285                 segment->continue_sample_iteration(it, 1);
 286         }
 287         segment->end_sample_iteration(it);
 288
 289         p.drawPolyline(points, point - points);
 290
 291         delete[] points;
 292 }
 293
 294 void AnalogSignal::paint_envelope(QPainter &p,
 295         const shared_ptr<pv::data::AnalogSegment> &segment,
 296         int y, int left, const int64_t start, const int64_t end,
 297         const double pixels_offset, const double samples_per_pixel)
 298 {
 299         using pv::data::AnalogSegment;
 300
 301         AnalogSegment::EnvelopeSection e;
 302         segment->get_envelope_section(e, start, end, samples_per_pixel);
 303
 304         if (e.length < 2)
 305                 return;
 306
 307         p.setPen(QPen(Qt::NoPen));
 308         p.setBrush(base_->colour());
 309
 310         QRectF *const rects = new QRectF[e.length];
 311         QRectF *rect = rects;
 312
 313         for (uint64_t sample = 0; sample < e.length-1; sample++) {
 314                 const float x = ((e.scale * sample + e.start) /
 315                         samples_per_pixel - pixels_offset) + left;
 316                 const AnalogSegment::EnvelopeSample *const s =
 317                         e.samples + sample;
 318
 319                 // We overlap this sample with the next so that vertical
 320                 // gaps do not appear during steep rising or falling edges
 321                 const float b = y - max(s->max, (s+1)->min) * scale_;
 322                 const float t = y - min(s->min, (s+1)->max) * scale_;
 323
 324                 float h = b - t;
 325                 if (h >= 0.0f && h <= 1.0f)
 326                         h = 1.0f;
 327                 if (h <= 0.0f && h >= -1.0f)
 328                         h = -1.0f;
 329
 330                 *rect++ = QRectF(x, t, 1.0f, h);
 331         }
 332
 333         p.drawRects(rects, e.length);
 334
 335         delete[] rects;
 336         delete[] e.samples;
 337 }
 338
 339 float AnalogSignal::get_resolution(int scale_index)
 340 {
 341         const float seq[] = {1.0f, 2.0f, 5.0f};
 342
 343         const int offset = std::numeric_limits<int>::max() / (2 * countof(seq));
 344         const std::div_t d = std::div(
 345                 (int)(scale_index + countof(seq) * offset),
 346                 countof(seq));
 347
 348         return powf(10.0f, d.quot - offset) * seq[d.rem];
 349 }
 350
 351 void AnalogSignal::update_scale()
 352 {
 353         resolution_ = get_resolution(scale_index_);
 354         scale_ = div_height_ / resolution_;
 355 }
 356
 357 void AnalogSignal::perform_autoranging(bool force_update)
 358 {
 359         const deque< shared_ptr<pv::data::AnalogSegment> > &segments =
 360                 base_->analog_data()->analog_segments();
 361
 362         if (segments.empty())
 363                 return;
 364
 365         static double prev_min = 0, prev_max = 0;
 366         double min = 0, max = 0;
 367
 368         for (shared_ptr<pv::data::AnalogSegment> segment : segments) {
 369                 std::pair<double, double> mm = segment->get_min_max();
 370                 min = std::min(min, mm.first);
 371                 max = std::max(max, mm.second);
 372         }
 373
 374         if ((min == prev_min) && (max == prev_max) && !force_update)
 375                 return;
 376
 377         prev_min = min;
 378         prev_max = max;
 379
 380         // Use all divs for the positive range if there are no negative values
 381         if ((min == 0) && (neg_vdivs_ > 0)) {
 382                 pos_vdivs_ += neg_vdivs_;
 383                 neg_vdivs_ = 0;
 384         }
 385
 386         double min_value_per_div;
 387         if ((pos_vdivs_ > 0) && (neg_vdivs_ >  0))
 388                 min_value_per_div = std::max(max / pos_vdivs_, -min / neg_vdivs_);
 389         else if (pos_vdivs_ > 0)
 390                 min_value_per_div = max / pos_vdivs_;
 391         else
 392                 min_value_per_div = -min / neg_vdivs_;
 393
 394         // Find first scale value that is bigger than the value we need
 395         for (int i = MinScaleIndex; i < MaxScaleIndex; i++)
 396                 if (get_resolution(i) > min_value_per_div) {
 397                         scale_index_ = i;
 398                         break;
 399                 }
 400
 401         update_scale();
 402 }
 403
 404 void AnalogSignal::populate_popup_form(QWidget *parent, QFormLayout *form)
 405 {
 406         // Add the standard options
 407         Signal::populate_popup_form(parent, form);
 408
 409         QFormLayout *const layout = new QFormLayout;
 410
 411         // Add the number of vdivs
 412         QSpinBox *pvdiv_sb = new QSpinBox(parent);
 413         pvdiv_sb->setRange(0, MaximumVDivs);
 414         pvdiv_sb->setValue(pos_vdivs_);
 415         connect(pvdiv_sb, SIGNAL(valueChanged(int)),
 416                 this, SLOT(on_pos_vdivs_changed(int)));
 417         layout->addRow(tr("Number of pos vertical divs"), pvdiv_sb);
 418
 419         QSpinBox *nvdiv_sb = new QSpinBox(parent);
 420         nvdiv_sb->setRange(0, MaximumVDivs);
 421         nvdiv_sb->setValue(neg_vdivs_);
 422         connect(nvdiv_sb, SIGNAL(valueChanged(int)),
 423                 this, SLOT(on_neg_vdivs_changed(int)));
 424         layout->addRow(tr("Number of neg vertical divs"), nvdiv_sb);
 425
 426         // Add the vertical resolution
 427         resolution_cb_ = new QComboBox(parent);
 428
 429         for (int i = MinScaleIndex; i < MaxScaleIndex; i++) {
 430                 const QString label = QString("%1").arg(get_resolution(i));
 431                 resolution_cb_->insertItem(0, label, QVariant(i));
 432         }
 433
 434         const int cur_idx = resolution_cb_->findData(QVariant(scale_index_));
 435         resolution_cb_->setCurrentIndex(cur_idx);
 436
 437         connect(resolution_cb_, SIGNAL(currentIndexChanged(int)),
 438                 this, SLOT(on_resolution_changed(int)));
 439
 440         QGridLayout *const vdiv_layout = new QGridLayout;
 441         QLabel *const vdiv_unit = new QLabel(tr("V/div"));
 442         vdiv_layout->addWidget(resolution_cb_, 0, 0);
 443         vdiv_layout->addWidget(vdiv_unit, 0, 1);
 444
 445         layout->addRow(tr("Vertical resolution"), vdiv_layout);
 446
 447         // Add the autoranging checkbox
 448         QCheckBox* autoranging_cb = new QCheckBox();
 449         autoranging_cb->setCheckState(autoranging_ ? Qt::Checked : Qt::Unchecked);
 450
 451         connect(autoranging_cb, SIGNAL(stateChanged(int)),
 452                 this, SLOT(on_autoranging_changed(int)));
 453
 454         layout->addRow(tr("Autoranging"), autoranging_cb);
 455
 456         form->addRow(layout);
 457 }
 458
 459 void AnalogSignal::on_pos_vdivs_changed(int vdivs)
 460 {
 461         pos_vdivs_ = vdivs;
 462
 463         if (autoranging_)
 464                 perform_autoranging(true);
 465
 466         if (owner_) {
 467                 // Call order is important, otherwise the lazy event handler won't work
 468                 owner_->extents_changed(false, true);
 469                 owner_->row_item_appearance_changed(false, true);
 470         }
 471 }
 472
 473 void AnalogSignal::on_neg_vdivs_changed(int vdivs)
 474 {
 475         neg_vdivs_ = vdivs;
 476
 477         if (autoranging_)
 478                 perform_autoranging(true);
 479
 480         if (owner_) {
 481                 // Call order is important, otherwise the lazy event handler won't work
 482                 owner_->extents_changed(false, true);
 483                 owner_->row_item_appearance_changed(false, true);
 484         }
 485 }
 486
 487 void AnalogSignal::on_resolution_changed(int index)
 488 {
 489         scale_index_ = resolution_cb_->itemData(index).toInt();
 490         update_scale();
 491
 492         if (owner_)
 493                 owner_->row_item_appearance_changed(false, true);
 494 }
 495
 496 void AnalogSignal::on_autoranging_changed(int state)
 497 {
 498         autoranging_ = (state == Qt::Checked);
 499
 500         if (autoranging_)
 501                 perform_autoranging(true);
 502
 503         if (owner_)
 504                 owner_->row_item_appearance_changed(false, true);
 505 }
 506
 507 } // namespace TraceView
 508 } // namespace views
 509 } // namespace pv