Restart min-max-based conversion if min or max change

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

diff --git a/pv/data/signalbase.hpp b/pv/data/signalbase.hpp
index 322bdf48e8c3a026d2156aa6ab75e05b024e9935..32085a43b929a68e5223019eb04ec94e81e3e88f 100644 (file)
--- a/pv/data/signalbase.hpp
+++ b/pv/data/signalbase.hpp
@@ -24,18 +24,23 @@
 #include <atomic>
 #include <condition_variable>
 #include <thread>
+#include <vector>
 
 #include <QColor>
 #include <QObject>
 #include <QSettings>
 #include <QString>
+#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;
@@ -55,16 +60,16 @@ class SignalBase : public QObject
 
 public:
        enum ChannelType {
-               AnalogChannel = 1,
-               LogicChannel,
-               DecodeChannel,
-               A2LChannel,  // Analog converted to logic, joint representation
-               MathChannel
+               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
        };
 
@@ -157,11 +162,82 @@ public:
         */
        shared_ptr<pv::data::Logic> logic_data() const;
 
+       /**
+        * Queries the kind of conversion performed on this channel.
+        */
+       ConversionType get_conversion_type() const;
+
        /**
         * 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.
+        */
+       int 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(int id);
+
 #ifdef ENABLE_DECODE
        bool is_decode_signal() const;
 #endif
@@ -170,14 +246,17 @@ public:
 
        virtual void restore_settings(QSettings &settings);
 
+       void start_conversion();
+
 private:
+       bool conversion_is_a2l() const;
+
        uint8_t convert_a2l_threshold(float threshold, float value);
        uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
                float value, uint8_t &state);
 
        void conversion_thread_proc(QObject* segment);
 
-       void start_conversion();
        void stop_conversion();
 
 Q_SIGNALS:
@@ -200,6 +279,8 @@ private Q_SLOTS:
        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);
 
 protected:
@@ -207,7 +288,10 @@ protected:
        ChannelType channel_type_;
        shared_ptr<pv::data::SignalData> data_;
        shared_ptr<pv::data::SignalData> converted_data_;
-       int conversion_type_;
+       ConversionType conversion_type_;
+       map<QString, QVariant> conversion_options_;
+
+       float min_value_, max_value_;
 
        std::thread conversion_thread_;
        atomic<bool> conversion_interrupt_;