pv/data/signalbase.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef PULSEVIEW_PV_DATA_SIGNALBASE_HPP
  22 #define PULSEVIEW_PV_DATA_SIGNALBASE_HPP
  23
  24 #include <atomic>
  25 #include <condition_variable>
  26 #include <thread>
  27 #include <vector>
  28
  29 #include <QColor>
  30 #include <QObject>
  31 #include <QSettings>
  32 #include <QString>
  33 #include <QTimer>
  34 #include <QVariant>
  35
  36 #include <libsigrokcxx/libsigrokcxx.hpp>
  37
  38 using std::atomic;
  39 using std::condition_variable;
  40 using std::map;
  41 using std::mutex;
  42 using std::pair;
  43 using std::shared_ptr;
  44 using std::vector;
  45
  46 namespace sigrok {
  47 class Channel;
  48 }
  49
  50 namespace pv {
  51 namespace data {
  52
  53 class Analog;
  54 class DecoderStack;
  55 class Logic;
  56 class SignalData;
  57
  58 class SignalBase : public QObject
  59 {
  60         Q_OBJECT
  61
  62 public:
  63         enum ChannelType {
  64                 AnalogChannel = 1, ///< Analog data
  65                 LogicChannel,  ///< Logic data
  66                 DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
  67                 MathChannel    ///< Virtual channel generated by math operations
  68         };
  69
  70         enum ConversionType {
  71                 NoConversion = 0,
  72                 A2LConversionByThreshold = 1,
  73                 A2LConversionBySchmittTrigger = 2
  74         };
  75
  76         /**
  77          * Conversion presets range from -1 to n, where 1..n are dependent on
  78          * the conversion these presets apply to. -1 and 0 have fixed meanings,
  79          * however.
  80          */
  81         enum ConversionPreset {
  82                 NoPreset = -1,     ///< Conversion uses custom values
  83                 DynamicPreset = 0  ///< Conversion uses calculated values
  84         };
  85
  86 private:
  87         static const int ColourBGAlpha;
  88         static const uint64_t ConversionBlockSize;
  89         static const uint32_t ConversionDelay;
  90
  91 public:
  92         SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
  93         virtual ~SignalBase();
  94
  95 public:
  96         /**
  97          * Returns the underlying SR channel.
  98          */
  99         shared_ptr<sigrok::Channel> channel() const;
 100
 101         /**
 102          * Returns enabled status of this channel.
 103          */
 104         bool enabled() const;
 105
 106         /**
 107          * Sets the enabled status of this channel.
 108          * @param value Boolean value to set.
 109          */
 110         void set_enabled(bool value);
 111
 112         /**
 113          * Gets the type of this channel.
 114          */
 115         ChannelType type() const;
 116
 117         /**
 118          * Gets the index number of this channel, i.e. a unique ID assigned by
 119          * the device driver.
 120          */
 121         unsigned int index() const;
 122
 123         /**
 124          * Returns which bit of a given sample for this signal represents the
 125          * signal itself. This is relevant for compound signals like logic,
 126          * rather meaningless for everything else but provided in case there
 127          * is a conversion active that provides a digital signal using bit #0.
 128          */
 129         unsigned int logic_bit_index() const;
 130
 131         /**
 132          * Gets the name of this signal.
 133          */
 134         QString name() const;
 135
 136         /**
 137          * Gets the internal name of this signal, i.e. how the device calls it.
 138          */
 139         QString internal_name() const;
 140
 141         /**
 142          * Sets the name of the signal.
 143          */
 144         virtual void set_name(QString name);
 145
 146         /**
 147          * Get the colour of the signal.
 148          */
 149         QColor colour() const;
 150
 151         /**
 152          * Set the colour of the signal.
 153          */
 154         void set_colour(QColor colour);
 155
 156         /**
 157          * Get the background colour of the signal.
 158          */
 159         QColor bgcolour() const;
 160
 161         /**
 162          * Sets the internal data object.
 163          */
 164         void set_data(shared_ptr<pv::data::SignalData> data);
 165
 166         /**
 167          * Get the internal data as analog data object in case of analog type.
 168          */
 169         shared_ptr<pv::data::Analog> analog_data() const;
 170
 171         /**
 172          * Get the internal data as logic data object in case of logic type.
 173          */
 174         shared_ptr<pv::data::Logic> logic_data() const;
 175
 176         /**
 177          * Queries the kind of conversion performed on this channel.
 178          */
 179         ConversionType get_conversion_type() const;
 180
 181         /**
 182          * Changes the kind of conversion performed on this channel.
 183          *
 184          * Restarts the conversion.
 185          */
 186         void set_conversion_type(ConversionType t);
 187
 188         /**
 189          * Returns all currently known conversion options
 190          */
 191         map<QString, QVariant> get_conversion_options() const;
 192
 193         /**
 194          * Sets the value of a particular conversion option
 195          * Note: it is not checked whether the option is valid for the
 196          * currently conversion. If it's not, it will be silently ignored.
 197          *
 198          * Does not restart the conversion.
 199          *
 200          * @return true if the value is different from before, false otherwise
 201          */
 202         bool set_conversion_option(QString key, QVariant value);
 203
 204         /**
 205          * Returns the threshold(s) used for conversions, if applicable.
 206          * The resulting thresholds are given for the chosen conversion, so you
 207          * can query thresholds also for conversions which aren't currently active.
 208          *
 209          * If you want the thresholds for the currently active conversion,
 210          * call it either with NoConversion or no parameter.
 211          *
 212          * @param t the type of conversion to obtain the thresholds for, leave
 213          *          empty or use NoConversion if you want to query the currently
 214          *          used conversion
 215          *
 216          * @param always_custom ignore the currently selected preset and always
 217          *        return the custom values for this conversion, using 0 if those
 218          *        aren't set
 219          *
 220          * @return a list of threshold(s) used by the chosen conversion
 221          */
 222         vector<double> get_conversion_thresholds(
 223                 const ConversionType t = NoConversion, const bool always_custom=false) const;
 224
 225         /**
 226          * Provides all conversion presets available for the currently active
 227          * conversion.
 228          *
 229          * @return a list of description/ID pairs for each preset
 230          */
 231         vector<pair<QString, int> > get_conversion_presets() const;
 232
 233         /**
 234          * Determines the ID of the currently used conversion preset, which is only
 235          * valid for the currently available conversion presets. It is therefore
 236          * suggested to call @ref get_conversion_presets right before calling this.
 237          *
 238          * @return the ID of the currently used conversion preset. -1 if no preset
 239          *         is used. In that case, a user setting is used instead.
 240          */
 241         ConversionPreset get_current_conversion_preset() const;
 242
 243         /**
 244          * Sets the conversion preset to be used.
 245          *
 246          * Does not restart the conversion.
 247          *
 248          * @param id the id of the preset to use
 249          */
 250         void set_conversion_preset(ConversionPreset id);
 251
 252 #ifdef ENABLE_DECODE
 253         bool is_decode_signal() const;
 254 #endif
 255
 256         virtual void save_settings(QSettings &settings) const;
 257
 258         virtual void restore_settings(QSettings &settings);
 259
 260         void start_conversion(bool delayed_start=false);
 261
 262 private:
 263         bool conversion_is_a2l() const;
 264
 265         uint8_t convert_a2l_threshold(float threshold, float value);
 266         uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
 267                 float value, uint8_t &state);
 268
 269         void conversion_thread_proc(QObject* segment);
 270
 271         void stop_conversion();
 272
 273 Q_SIGNALS:
 274         void enabled_changed(const bool &value);
 275
 276         void name_changed(const QString &name);
 277
 278         void colour_changed(const QColor &colour);
 279
 280         void conversion_type_changed(const ConversionType t);
 281
 282         void samples_cleared();
 283
 284         void samples_added(QObject* segment, uint64_t start_sample,
 285                 uint64_t end_sample);
 286
 287         void min_max_changed(float min, float max);
 288
 289 private Q_SLOTS:
 290         void on_samples_cleared();
 291
 292         void on_samples_added(QObject* segment, uint64_t start_sample,
 293                 uint64_t end_sample);
 294
 295         void on_min_max_changed(float min, float max);
 296
 297         void on_capture_state_changed(int state);
 298
 299         void on_delayed_conversion_start();
 300
 301 protected:
 302         shared_ptr<sigrok::Channel> channel_;
 303         ChannelType channel_type_;
 304         shared_ptr<pv::data::SignalData> data_;
 305         shared_ptr<pv::data::SignalData> converted_data_;
 306         ConversionType conversion_type_;
 307         map<QString, QVariant> conversion_options_;
 308
 309         float min_value_, max_value_;
 310
 311         std::thread conversion_thread_;
 312         atomic<bool> conversion_interrupt_;
 313         mutex conversion_input_mutex_;
 314         condition_variable conversion_input_cond_;
 315         QTimer delayed_conversion_starter_;
 316
 317         QString internal_name_, name_;
 318         QColor colour_, bgcolour_;
 319 };
 320
 321 } // namespace data
 322 } // namespace pv
 323
 324 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP