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 AnalogSegment;
  55 class DecoderStack;
  56 class Logic;
  57 class LogicSegment;
  58 class Segment;
  59 class SignalData;
  60
  61 class SignalBase : public QObject
  62 {
  63         Q_OBJECT
  64
  65 public:
  66         enum ChannelType {
  67                 AnalogChannel = 1, ///< Analog data
  68                 LogicChannel,  ///< Logic data
  69                 DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
  70                 MathChannel    ///< Virtual channel generated by math operations
  71         };
  72
  73         enum ConversionType {
  74                 NoConversion = 0,
  75                 A2LConversionByThreshold = 1,
  76                 A2LConversionBySchmittTrigger = 2
  77         };
  78
  79         /**
  80          * Conversion presets range from -1 to n, where 1..n are dependent on
  81          * the conversion these presets apply to. -1 and 0 have fixed meanings,
  82          * however.
  83          */
  84         enum ConversionPreset {
  85                 NoPreset = -1,     ///< Conversion uses custom values
  86                 DynamicPreset = 0  ///< Conversion uses calculated values
  87         };
  88
  89 private:
  90         static const int ColorBGAlpha;
  91         static const uint64_t ConversionBlockSize;
  92         static const uint32_t ConversionDelay;
  93
  94 public:
  95         SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
  96         virtual ~SignalBase();
  97
  98 public:
  99         /**
 100          * Returns the underlying SR channel.
 101          */
 102         shared_ptr<sigrok::Channel> channel() const;
 103
 104         /**
 105          * Returns enabled status of this channel.
 106          */
 107         bool enabled() const;
 108
 109         /**
 110          * Sets the enabled status of this channel.
 111          * @param value Boolean value to set.
 112          */
 113         void set_enabled(bool value);
 114
 115         /**
 116          * Gets the type of this channel.
 117          */
 118         ChannelType type() const;
 119
 120         /**
 121          * Gets the index number of this channel, i.e. a unique ID assigned by
 122          * the device driver.
 123          */
 124         unsigned int index() const;
 125
 126         /**
 127          * Returns which bit of a given sample for this signal represents the
 128          * signal itself. This is relevant for compound signals like logic,
 129          * rather meaningless for everything else but provided in case there
 130          * is a conversion active that provides a digital signal using bit #0.
 131          */
 132         unsigned int logic_bit_index() const;
 133
 134         /**
 135          * Gets the name of this signal.
 136          */
 137         QString name() const;
 138
 139         /**
 140          * Gets the internal name of this signal, i.e. how the device calls it.
 141          */
 142         QString internal_name() const;
 143
 144         /**
 145          * Produces a string for this signal that can be used for display,
 146          * i.e. it contains one or both of the signal/internal names.
 147          */
 148         QString display_name() const;
 149
 150         /**
 151          * Sets the name of the signal.
 152          */
 153         virtual void set_name(QString name);
 154
 155         /**
 156          * Get the color of the signal.
 157          */
 158         QColor color() const;
 159
 160         /**
 161          * Set the color of the signal.
 162          */
 163         void set_color(QColor color);
 164
 165         /**
 166          * Get the background color of the signal.
 167          */
 168         QColor bgcolor() const;
 169
 170         /**
 171          * Sets the internal data object.
 172          */
 173         void set_data(shared_ptr<pv::data::SignalData> data);
 174
 175         /**
 176          * Clears all sample data and removes all associated segments.
 177          */
 178         void clear_sample_data();
 179
 180         /**
 181          * Get the internal data as analog data object in case of analog type.
 182          */
 183         shared_ptr<pv::data::Analog> analog_data() const;
 184
 185         /**
 186          * Get the internal data as logic data object in case of logic type.
 187          */
 188         shared_ptr<pv::data::Logic> logic_data() const;
 189
 190         /**
 191          * Determines whether a given segment is complete (i.e. end-of-frame has
 192          * been seen). It only considers the original data, not the converted data.
 193          */
 194         bool segment_is_complete(uint32_t segment_id) const;
 195
 196         /**
 197          * Determines whether this signal has any sample data at all.
 198          */
 199         bool has_samples() const;
 200
 201         /**
 202          * Returns the sample rate for this signal.
 203          */
 204         virtual double get_samplerate() const;
 205
 206         /**
 207          * Queries the kind of conversion performed on this channel.
 208          */
 209         ConversionType get_conversion_type() const;
 210
 211         /**
 212          * Changes the kind of conversion performed on this channel.
 213          *
 214          * Restarts the conversion.
 215          */
 216         void set_conversion_type(ConversionType t);
 217
 218         /**
 219          * Returns all currently known conversion options
 220          */
 221         map<QString, QVariant> get_conversion_options() const;
 222
 223         /**
 224          * Sets the value of a particular conversion option
 225          * Note: it is not checked whether the option is valid for the
 226          * currently conversion. If it's not, it will be silently ignored.
 227          *
 228          * Does not restart the conversion.
 229          *
 230          * @return true if the value is different from before, false otherwise
 231          */
 232         bool set_conversion_option(QString key, QVariant value);
 233
 234         /**
 235          * Returns the threshold(s) used for conversions, if applicable.
 236          * The resulting thresholds are given for the chosen conversion, so you
 237          * can query thresholds also for conversions which aren't currently active.
 238          *
 239          * If you want the thresholds for the currently active conversion,
 240          * call it either with NoConversion or no parameter.
 241          *
 242          * @param t the type of conversion to obtain the thresholds for, leave
 243          *          empty or use NoConversion if you want to query the currently
 244          *          used conversion
 245          *
 246          * @param always_custom ignore the currently selected preset and always
 247          *        return the custom values for this conversion, using 0 if those
 248          *        aren't set
 249          *
 250          * @return a list of threshold(s) used by the chosen conversion
 251          */
 252         vector<double> get_conversion_thresholds(
 253                 const ConversionType t = NoConversion, const bool always_custom=false) const;
 254
 255         /**
 256          * Provides all conversion presets available for the currently active
 257          * conversion.
 258          *
 259          * @return a list of description/ID pairs for each preset
 260          */
 261         vector<pair<QString, int> > get_conversion_presets() const;
 262
 263         /**
 264          * Determines the ID of the currently used conversion preset, which is only
 265          * valid for the currently available conversion presets. It is therefore
 266          * suggested to call @ref get_conversion_presets right before calling this.
 267          *
 268          * @return the ID of the currently used conversion preset. -1 if no preset
 269          *         is used. In that case, a user setting is used instead.
 270          */
 271         ConversionPreset get_current_conversion_preset() const;
 272
 273         /**
 274          * Sets the conversion preset to be used.
 275          *
 276          * Does not restart the conversion.
 277          *
 278          * @param id the id of the preset to use
 279          */
 280         void set_conversion_preset(ConversionPreset id);
 281
 282 #ifdef ENABLE_DECODE
 283         bool is_decode_signal() const;
 284 #endif
 285
 286         virtual void save_settings(QSettings &settings) const;
 287
 288         virtual void restore_settings(QSettings &settings);
 289
 290         void start_conversion(bool delayed_start=false);
 291
 292 private:
 293         bool conversion_is_a2l() const;
 294
 295         uint8_t convert_a2l_threshold(float threshold, float value);
 296         uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
 297                 float value, uint8_t &state);
 298
 299         void convert_single_segment_range(AnalogSegment *asegment,
 300                 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample);
 301         void convert_single_segment(pv::data::AnalogSegment *asegment,
 302                 pv::data::LogicSegment *lsegment);
 303         void conversion_thread_proc();
 304
 305         void stop_conversion();
 306
 307 Q_SIGNALS:
 308         void enabled_changed(const bool &value);
 309
 310         void name_changed(const QString &name);
 311
 312         void color_changed(const QColor &color);
 313
 314         void conversion_type_changed(const ConversionType t);
 315
 316         void samples_cleared();
 317
 318         void samples_added(uint64_t segment_id, uint64_t start_sample,
 319                 uint64_t end_sample);
 320
 321         void min_max_changed(float min, float max);
 322
 323 private Q_SLOTS:
 324         void on_samples_cleared();
 325
 326         void on_samples_added(shared_ptr<Segment> segment, uint64_t start_sample,
 327                 uint64_t end_sample);
 328
 329         void on_min_max_changed(float min, float max);
 330
 331         void on_capture_state_changed(int state);
 332
 333         void on_delayed_conversion_start();
 334
 335 protected:
 336         shared_ptr<sigrok::Channel> channel_;
 337         ChannelType channel_type_;
 338         shared_ptr<pv::data::SignalData> data_;
 339         shared_ptr<pv::data::SignalData> converted_data_;
 340         ConversionType conversion_type_;
 341         map<QString, QVariant> conversion_options_;
 342
 343         float min_value_, max_value_;
 344
 345         std::thread conversion_thread_;
 346         atomic<bool> conversion_interrupt_;
 347         mutex conversion_input_mutex_;
 348         condition_variable conversion_input_cond_;
 349         QTimer delayed_conversion_starter_;
 350
 351         QString internal_name_, name_;
 352         QColor color_, bgcolor_;
 353 };
 354
 355 } // namespace data
 356 } // namespace pv
 357
 358 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP