]> sigrok.org Git - pulseview.git/blobdiff - pv/data/signalbase.hpp
Restart min-max-based conversion if min or max change
[pulseview.git] / pv / data / signalbase.hpp
index b29c6b56558d3dffb74cd22429d20a6b80efb7a9..32085a43b929a68e5223019eb04ec94e81e3e88f 100644 (file)
 #ifndef PULSEVIEW_PV_DATA_SIGNALBASE_HPP
 #define PULSEVIEW_PV_DATA_SIGNALBASE_HPP
 
+#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;
@@ -50,21 +60,22 @@ 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
        };
 
 private:
        static const int ColourBGAlpha;
+       static const uint64_t ConversionBlockSize;
 
 public:
        SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
@@ -93,10 +104,19 @@ public:
        ChannelType type() const;
 
        /**
-        * Gets the index number of this channel.
+        * Gets the index number of this channel, i.e. a unique ID assigned by
+        * the device driver.
         */
        unsigned int index() const;
 
+       /**
+        * Returns which bit of a given sample for this signal represents the
+        * signal itself. This is relevant for compound signals like logic,
+        * rather meaningless for everything else but provided in case there
+        * is a conversion active that provides a digital signal using bit #0.
+        */
+       unsigned int logic_bit_index() const;
+
        /**
         * Gets the name of this signal.
         */
@@ -142,29 +162,102 @@ 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);
 
-#ifdef ENABLE_DECODE
-       bool is_decode_signal() const;
+       /**
+        * Returns all currently known conversion options
+        */
+       map<QString, QVariant> get_conversion_options() const;
 
-       shared_ptr<pv::data::DecoderStack> decoder_stack() 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;
 
-       void set_decoder_stack(shared_ptr<pv::data::DecoderStack> decoder_stack);
+       /**
+        * 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
 
-       void save_settings(QSettings &settings) const;
+       virtual void save_settings(QSettings &settings) const;
 
-       void restore_settings(QSettings &settings);
+       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 convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
+               float value, uint8_t &state);
 
-       void conversion_thread_proc(QObject* segment, uint64_t start_sample,
-               uint64_t end_sample);
+       void conversion_thread_proc(QObject* segment);
+
+       void stop_conversion();
 
 Q_SIGNALS:
        void enabled_changed(const bool &value);
@@ -175,26 +268,35 @@ Q_SIGNALS:
 
        void conversion_type_changed(const ConversionType t);
 
+       void samples_cleared();
+
+       void samples_added(QObject* segment, uint64_t start_sample,
+               uint64_t end_sample);
+
 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);
 
-private:
+protected:
        shared_ptr<sigrok::Channel> channel_;
        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_;
 
-#ifdef ENABLE_DECODE
-       shared_ptr<pv::data::DecoderStack> decoder_stack_;
-#endif
+       float min_value_, max_value_;
 
        std::thread conversion_thread_;
+       atomic<bool> conversion_interrupt_;
+       mutex conversion_input_mutex_;
+       condition_variable conversion_input_cond_;
 
        QString internal_name_, name_;
        QColor colour_, bgcolour_;