]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.cpp
Provide short-term fix for #627 by limiting zoom range to 100 ps
[pulseview.git] / pv / view / view.cpp
index 2ae0a7144cba4b9b15abbc34f3e9265e14f43250..fdb9354b9315cefe4c4a06d23b00a879db7bab82 100644 (file)
@@ -61,6 +61,7 @@ using boost::shared_mutex;
 using pv::data::SignalData;
 using pv::data::Segment;
 using pv::util::format_time;
+using pv::util::TimeUnit;
 
 using std::deque;
 using std::dynamic_pointer_cast;
@@ -83,9 +84,10 @@ namespace pv {
 namespace view {
 
 const double View::MaxScale = 1e9;
-const double View::MinScale = 1e-15;
+const double View::MinScale = 1e-12;
 
 const int View::MaxScrollValue = INT_MAX / 2;
+const int View::MaxViewAutoUpdateRate = 25; // No more than 25 Hz with sticky scrolling
 
 const int View::ScaleUnits[3] = {1, 2, 5};
 
@@ -98,8 +100,12 @@ View::View(Session &session, QWidget *parent) :
        scale_(1e-3),
        offset_(0),
        updating_scroll_(false),
+       sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
+       always_zoom_to_fit_(false),
        tick_period_(0.0),
        tick_prefix_(0),
+       tick_precision_(0),
+       time_unit_(util::Time),
        show_cursors_(false),
        cursors_(new CursorPair(*this)),
        next_flag_text_('A'),
@@ -113,7 +119,7 @@ View::View(Session &session, QWidget *parent) :
        connect(&session_, SIGNAL(signals_changed()),
                this, SLOT(signals_changed()));
        connect(&session_, SIGNAL(capture_state_changed(int)),
-               this, SLOT(data_updated()));
+               this, SLOT(capture_state_updated(int)));
        connect(&session_, SIGNAL(data_received()),
                this, SLOT(data_updated()));
        connect(&session_, SIGNAL(frame_ended()),
@@ -136,6 +142,11 @@ View::View(Session &session, QWidget *parent) :
                this, SLOT(process_sticky_events()));
        lazy_event_handler_.setSingleShot(true);
 
+       connect(&delayed_view_updater_, SIGNAL(timeout()),
+               this, SLOT(perform_delayed_view_update()));
+       delayed_view_updater_.setSingleShot(true);
+       delayed_view_updater_.setInterval(1000 / MaxViewAutoUpdateRate);
+
        setViewport(viewport_);
 
        viewport_->installEventFilter(this);
@@ -226,11 +237,21 @@ unsigned int View::tick_prefix() const
        return tick_prefix_;
 }
 
+unsigned int View::tick_precision() const
+{
+       return tick_precision_;
+}
+
 double View::tick_period() const
 {
        return tick_period_;
 }
 
+TimeUnit View::time_unit() const
+{
+       return time_unit_;
+}
+
 void View::zoom(double steps)
 {
        zoom(steps, viewport_->width() / 2);
@@ -241,8 +262,17 @@ void View::zoom(double steps, int offset)
        set_zoom(scale_ * pow(3.0/2.0, -steps), offset);
 }
 
-void View::zoom_fit()
+void View::zoom_fit(bool gui_state)
 {
+       // Act as one-shot when stopped, toggle along with the GUI otherwise
+       if (session_.get_capture_state() == Session::Stopped) {
+               always_zoom_to_fit_ = false;
+               always_zoom_to_fit_changed(false);
+       } else {
+               always_zoom_to_fit_ = gui_state;
+               always_zoom_to_fit_changed(gui_state);
+       }
+
        const pair<double, double> extents = get_time_extents();
        const double delta = extents.second - extents.first;
        if (delta < 1e-12)
@@ -288,6 +318,22 @@ void View::zoom_one_to_one()
 
 void View::set_scale_offset(double scale, double offset)
 {
+       // Disable sticky scrolling / always zoom to fit when acquisition runs
+       // and user drags the viewport
+       if ((scale_ == scale) && (offset_ != offset) &&
+                       (session_.get_capture_state() == Session::Running)) {
+
+               if (sticky_scrolling_) {
+                       sticky_scrolling_ = false;
+                       sticky_scrolling_changed(false);
+               }
+
+               if (always_zoom_to_fit_) {
+                       always_zoom_to_fit_ = false;
+                       always_zoom_to_fit_changed(false);
+               }
+       }
+
        scale_ = scale;
        offset_ = offset;
 
@@ -339,6 +385,11 @@ pair<double, double> View::get_time_extents() const
        return make_pair(left_time, right_time);
 }
 
+void View::enable_sticky_scrolling(bool state)
+{
+       sticky_scrolling_ = state;
+}
+
 bool View::cursors_shown() const
 {
        return show_cursors_;
@@ -430,6 +481,10 @@ void View::get_scroll_layout(double &length, double &offset) const
 
 void View::set_zoom(double scale, int offset)
 {
+       // Reset the "always zoom to fit" feature as the user changed the zoom
+       always_zoom_to_fit_ = false;
+       always_zoom_to_fit_changed(false);
+
        const double cursor_offset = offset_ + scale_ * offset;
        const double new_scale = max(min(scale, MaxScale), MinScale);
        const double new_offset = cursor_offset - new_scale * offset;
@@ -438,10 +493,16 @@ void View::set_zoom(double scale, int offset)
 
 void View::calculate_tick_spacing()
 {
-       const double SpacingIncrement = 32.0f;
-       const double MinValueSpacing = 32.0f;
+       const double SpacingIncrement = 10.0f;
+       const double MinValueSpacing = 25.0f;
+
+       // Figure out the highest numeric value visible on a label
+       const QSize areaSize = viewport_->size();
+       const double max_time = max(fabs(offset_),
+               fabs(offset_ + scale_ * areaSize.width()));
 
-       double min_width = SpacingIncrement, typical_width;
+       double min_width = SpacingIncrement;
+       double label_width, tick_period_width;
 
        QFontMetrics m(QApplication::font());
 
@@ -451,23 +512,37 @@ void View::calculate_tick_spacing()
                const int order = (int)floorf(log10f(min_period));
                const double order_decimal = pow(10.0, order);
 
+               // Allow for a margin of error so that a scale unit of 1 can be used.
+               // Otherwise, for a SU of 1 the tick period will almost always be below
+               // the min_period by a small amount - and thus skipped in favor of 2.
+               // Note: margin assumes that SU[0] and SU[1] contain the smallest values
+               double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
+               double tp_with_margin;
                unsigned int unit = 0;
 
                do {
-                       tick_period_ = order_decimal * ScaleUnits[unit++];
-               } while (tick_period_ < min_period &&
-                       unit < countof(ScaleUnits));
+                       tp_with_margin = order_decimal * (ScaleUnits[unit++] + tp_margin);
+               } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
 
+               tick_period_ = order_decimal * ScaleUnits[unit - 1];
                tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
 
-               typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
-                       Qt::AlignLeft | Qt::AlignTop,
-                       format_time(offset_, tick_prefix_)).width() +
+               // Precision is the number of fractional digits required, not
+               // taking the prefix into account (and it must never be negative)
+               tick_precision_ = std::max((int)ceil(log10f(1 / tick_period_)), 0);
+
+               tick_period_width = tick_period_ / scale_;
+
+               const QString label_text =
+                       format_time(max_time, tick_prefix_, time_unit_, tick_precision_);
+
+               label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
+                       Qt::AlignLeft | Qt::AlignTop, label_text).width() +
                                MinValueSpacing;
 
                min_width += SpacingIncrement;
 
-       } while(typical_width > tick_period_ / scale_);
+       } while (tick_period_width < label_width);
 }
 
 void View::update_scroll()
@@ -596,6 +671,28 @@ vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
        return filtered_traces;
 }
 
+void View::determine_time_unit()
+{
+       // Check whether we know the sample rate and hence can use time as the unit
+       if (time_unit_ == util::Samples) {
+               shared_lock<shared_mutex> lock(session().signals_mutex());
+               const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
+
+               // Check all signals but...
+               for (const shared_ptr<Signal> signal : sigs) {
+                       const shared_ptr<SignalData> data = signal->data();
+
+                       // ...only check first segment of each
+                       const vector< shared_ptr<Segment> > segments = data->segments();
+                       if (!segments.empty())
+                               if (segments[0]->samplerate()) {
+                                       time_unit_ = util::Time;
+                                       break;
+                               }
+               }
+       }
+}
+
 bool View::eventFilter(QObject *object, QEvent *event)
 {
        const QEvent::Type type = event->type();
@@ -674,6 +771,13 @@ void View::h_scroll_value_changed(int value)
        if (updating_scroll_)
                return;
 
+       // Disable sticky scrolling when user moves the horizontal scroll bar
+       // during a running acquisition
+       if (sticky_scrolling_ && (session_.get_capture_state() == Session::Running)) {
+               sticky_scrolling_ = false;
+               sticky_scrolling_changed(false);
+       }
+
        const int range = horizontalScrollBar()->maximum();
        if (range < MaxScrollValue)
                offset_ = scale_ * value;
@@ -819,12 +923,50 @@ void View::signals_changed()
        viewport_->update();
 }
 
+void View::capture_state_updated(int state)
+{
+       // Reset "always zoom to fit" when we change to the stopped state
+       if (always_zoom_to_fit_ && (state == Session::Stopped)) {
+               always_zoom_to_fit_ = false;
+               always_zoom_to_fit_changed(false);
+       }
+
+       if (state == Session::Running)
+               time_unit_ = util::Samples;
+}
+
 void View::data_updated()
 {
-       // Update the scroll bars
-       update_scroll();
+       if (always_zoom_to_fit_ || sticky_scrolling_) {
+               if (!delayed_view_updater_.isActive())
+                       delayed_view_updater_.start();
+       } else {
+               determine_time_unit();
+               update_scroll();
+               ruler_->update();
+               viewport_->update();
+       }
+}
+
+void View::perform_delayed_view_update()
+{
+       if (always_zoom_to_fit_)
+               zoom_fit(true);
+
+       if (sticky_scrolling_) {
+               // Make right side of the view sticky
+               double length = 0, offset;
+               get_scroll_layout(length, offset);
 
-       // Repaint the view
+               const QSize areaSize = viewport_->size();
+               length = max(length - areaSize.width(), 0.0);
+
+               offset_ = scale_ * length;
+       }
+
+       determine_time_unit();
+       update_scroll();
+       ruler_->update();
        viewport_->update();
 }