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
  28 #include <QColor>
  29 #include <QObject>
  30 #include <QSettings>
  31 #include <QString>
  32
  33 #include <libsigrokcxx/libsigrokcxx.hpp>
  34
  35 using std::atomic;
  36 using std::condition_variable;
  37 using std::mutex;
  38 using std::shared_ptr;
  39
  40 namespace sigrok {
  41 class Channel;
  42 }
  43
  44 namespace pv {
  45 namespace data {
  46
  47 class Analog;
  48 class DecoderStack;
  49 class Logic;
  50 class SignalData;
  51
  52 class SignalBase : public QObject
  53 {
  54         Q_OBJECT
  55
  56 public:
  57         enum ChannelType {
  58                 AnalogChannel = 1, ///< Analog data
  59                 LogicChannel,  ///< Logic data
  60                 DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
  61                 A2LChannel,    ///< Analog converted to logic, joint representation
  62                 MathChannel    ///< Virtual channel generated by math operations
  63         };
  64
  65         enum ConversionType {
  66                 NoConversion = 0,
  67                 A2LConversionByTreshold = 1,
  68                 A2LConversionBySchmittTrigger = 2
  69         };
  70
  71 private:
  72         static const int ColourBGAlpha;
  73         static const uint64_t ConversionBlockSize;
  74
  75 public:
  76         SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
  77         virtual ~SignalBase();
  78
  79 public:
  80         /**
  81          * Returns the underlying SR channel.
  82          */
  83         shared_ptr<sigrok::Channel> channel() const;
  84
  85         /**
  86          * Returns enabled status of this channel.
  87          */
  88         bool enabled() const;
  89
  90         /**
  91          * Sets the enabled status of this channel.
  92          * @param value Boolean value to set.
  93          */
  94         void set_enabled(bool value);
  95
  96         /**
  97          * Gets the type of this channel.
  98          */
  99         ChannelType type() const;
 100
 101         /**
 102          * Gets the index number of this channel, i.e. a unique ID assigned by
 103          * the device driver.
 104          */
 105         unsigned int index() const;
 106
 107         /**
 108          * Returns which bit of a given sample for this signal represents the
 109          * signal itself. This is relevant for compound signals like logic,
 110          * rather meaningless for everything else but provided in case there
 111          * is a conversion active that provides a digital signal using bit #0.
 112          */
 113         unsigned int logic_bit_index() const;
 114
 115         /**
 116          * Gets the name of this signal.
 117          */
 118         QString name() const;
 119
 120         /**
 121          * Gets the internal name of this signal, i.e. how the device calls it.
 122          */
 123         QString internal_name() const;
 124
 125         /**
 126          * Sets the name of the signal.
 127          */
 128         virtual void set_name(QString name);
 129
 130         /**
 131          * Get the colour of the signal.
 132          */
 133         QColor colour() const;
 134
 135         /**
 136          * Set the colour of the signal.
 137          */
 138         void set_colour(QColor colour);
 139
 140         /**
 141          * Get the background colour of the signal.
 142          */
 143         QColor bgcolour() const;
 144
 145         /**
 146          * Sets the internal data object.
 147          */
 148         void set_data(shared_ptr<pv::data::SignalData> data);
 149
 150         /**
 151          * Get the internal data as analog data object in case of analog type.
 152          */
 153         shared_ptr<pv::data::Analog> analog_data() const;
 154
 155         /**
 156          * Get the internal data as logic data object in case of logic type.
 157          */
 158         shared_ptr<pv::data::Logic> logic_data() const;
 159
 160         /**
 161          * Queries the kind of conversion performed on this channel.
 162          */
 163         ConversionType get_conversion_type() const;
 164
 165         /**
 166          * Changes the kind of conversion performed on this channel.
 167          */
 168         void set_conversion_type(ConversionType t);
 169
 170 #ifdef ENABLE_DECODE
 171         bool is_decode_signal() const;
 172 #endif
 173
 174         virtual void save_settings(QSettings &settings) const;
 175
 176         virtual void restore_settings(QSettings &settings);
 177
 178 private:
 179         bool conversion_is_a2l() const;
 180
 181         uint8_t convert_a2l_threshold(float threshold, float value);
 182         uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
 183                 float value, uint8_t &state);
 184
 185         void conversion_thread_proc(QObject* segment);
 186
 187         void start_conversion();
 188         void stop_conversion();
 189
 190 Q_SIGNALS:
 191         void enabled_changed(const bool &value);
 192
 193         void name_changed(const QString &name);
 194
 195         void colour_changed(const QColor &colour);
 196
 197         void conversion_type_changed(const ConversionType t);
 198
 199         void samples_cleared();
 200
 201         void samples_added(QObject* segment, uint64_t start_sample,
 202                 uint64_t end_sample);
 203
 204 private Q_SLOTS:
 205         void on_samples_cleared();
 206
 207         void on_samples_added(QObject* segment, uint64_t start_sample,
 208                 uint64_t end_sample);
 209
 210         void on_capture_state_changed(int state);
 211
 212 protected:
 213         shared_ptr<sigrok::Channel> channel_;
 214         ChannelType channel_type_;
 215         shared_ptr<pv::data::SignalData> data_;
 216         shared_ptr<pv::data::SignalData> converted_data_;
 217         ConversionType conversion_type_;
 218
 219         std::thread conversion_thread_;
 220         atomic<bool> conversion_interrupt_;
 221         mutex conversion_input_mutex_;
 222         condition_variable conversion_input_cond_;
 223
 224         QString internal_name_, name_;
 225         QColor colour_, bgcolour_;
 226 };
 227
 228 } // namespace data
 229 } // namespace pv
 230
 231 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP