Use min/max notification for autoranging of analog signals

[pulseview.git] / pv / data / signalbase.hpp

diff --git a/pv/data/signalbase.hpp b/pv/data/signalbase.hpp
index a2d23244f0e1d007aad79543f909fce796c8ab0c..865f2551662fed2ab137781752c9064191cb698d 100644 (file)
--- a/pv/data/signalbase.hpp
+++ b/pv/data/signalbase.hpp
@@ -24,18 +24,24 @@
 #include <atomic>
 #include <condition_variable>
 #include <thread>
+#include <vector>
 
 #include <QColor>
 #include <QObject>
 #include <QSettings>
 #include <QString>
+#include <QTimer>
+#include <QVariant>
 
 #include <libsigrokcxx/libsigrokcxx.hpp>
 
 using std::atomic;
 using std::condition_variable;
+using std::map;
 using std::mutex;
+using std::pair;
 using std::shared_ptr;
+using std::vector;
 
 namespace sigrok {
 class Channel;
@@ -58,19 +64,29 @@ public:
                AnalogChannel = 1, ///< Analog data
                LogicChannel,  ///< Logic data
                DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
-               A2LChannel,    ///< Analog converted to logic, joint representation
                MathChannel    ///< Virtual channel generated by math operations
        };
 
        enum ConversionType {
                NoConversion = 0,
-               A2LConversionByTreshold = 1,
+               A2LConversionByThreshold = 1,
                A2LConversionBySchmittTrigger = 2
        };
 
+       /**
+        * Conversion presets range from -1 to n, where 1..n are dependent on
+        * the conversion these presets apply to. -1 and 0 have fixed meanings,
+        * however.
+        */
+       enum ConversionPreset {
+               NoPreset = -1,     ///< Conversion uses custom values
+               DynamicPreset = 0  ///< Conversion uses calculated values
+       };
+
 private:
        static const int ColourBGAlpha;
        static const uint64_t ConversionBlockSize;
+       static const uint32_t ConversionDelay;
 
 public:
        SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
@@ -164,9 +180,75 @@ public:
 
        /**
         * Changes the kind of conversion performed on this channel.
+        *
+        * Restarts the conversion.
         */
        void set_conversion_type(ConversionType t);
 
+       /**
+        * Returns all currently known conversion options
+        */
+       map<QString, QVariant> get_conversion_options() const;
+
+       /**
+        * Sets the value of a particular conversion option
+        * Note: it is not checked whether the option is valid for the
+        * currently conversion. If it's not, it will be silently ignored.
+        *
+        * Does not restart the conversion.
+        *
+        * @return true if the value is different from before, false otherwise
+        */
+       bool set_conversion_option(QString key, QVariant value);
+
+       /**
+        * Returns the threshold(s) used for conversions, if applicable.
+        * The resulting thresholds are given for the chosen conversion, so you
+        * can query thresholds also for conversions which aren't currently active.
+        *
+        * If you want the thresholds for the currently active conversion,
+        * call it either with NoConversion or no parameter.
+        *
+        * @param t the type of conversion to obtain the thresholds for, leave
+        *          empty or use NoConversion if you want to query the currently
+        *          used conversion
+        *
+        * @param always_custom ignore the currently selected preset and always
+        *        return the custom values for this conversion, using 0 if those
+        *        aren't set
+        *
+        * @return a list of threshold(s) used by the chosen conversion
+        */
+       vector<double> get_conversion_thresholds(
+               const ConversionType t = NoConversion, const bool always_custom=false) const;
+
+       /**
+        * Provides all conversion presets available for the currently active
+        * conversion.
+        *
+        * @return a list of description/ID pairs for each preset
+        */
+       vector<pair<QString, int> > get_conversion_presets() const;
+
+       /**
+        * Determines the ID of the currently used conversion preset, which is only
+        * valid for the currently available conversion presets. It is therefore
+        * suggested to call @ref get_conversion_presets right before calling this.
+        *
+        * @return the ID of the currently used conversion preset. -1 if no preset
+        *         is used. In that case, a user setting is used instead.
+        */
+       ConversionPreset get_current_conversion_preset() const;
+
+       /**
+        * Sets the conversion preset to be used.
+        *
+        * Does not restart the conversion.
+        *
+        * @param id the id of the preset to use
+        */
+       void set_conversion_preset(ConversionPreset id);
+
 #ifdef ENABLE_DECODE
        bool is_decode_signal() const;
 #endif
@@ -175,6 +257,8 @@ public:
 
        virtual void restore_settings(QSettings &settings);
 
+       void start_conversion(bool delayed_start=false);
+
 private:
        bool conversion_is_a2l() const;
 
@@ -184,7 +268,6 @@ private:
 
        void conversion_thread_proc(QObject* segment);
 
-       void start_conversion();
        void stop_conversion();
 
 Q_SIGNALS:
@@ -201,25 +284,35 @@ Q_SIGNALS:
        void samples_added(QObject* segment, uint64_t start_sample,
                uint64_t end_sample);
 
+       void min_max_changed(float min, float max);
+
 private Q_SLOTS:
        void on_samples_cleared();
 
        void on_samples_added(QObject* segment, uint64_t start_sample,
                uint64_t end_sample);
 
+       void on_min_max_changed(float min, float max);
+
        void on_capture_state_changed(int state);
 
+       void on_delayed_conversion_start();
+
 protected:
        shared_ptr<sigrok::Channel> channel_;
        ChannelType channel_type_;
        shared_ptr<pv::data::SignalData> data_;
        shared_ptr<pv::data::SignalData> converted_data_;
        ConversionType conversion_type_;
+       map<QString, QVariant> conversion_options_;
+
+       float min_value_, max_value_;
 
        std::thread conversion_thread_;
        atomic<bool> conversion_interrupt_;
        mutex conversion_input_mutex_;
        condition_variable conversion_input_cond_;
+       QTimer delayed_conversion_starter_;
 
        QString internal_name_, name_;
        QColor colour_, bgcolour_;