2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5 * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
21 #ifndef PULSEVIEW_PV_DATA_SIGNALBASE_HPP
22 #define PULSEVIEW_PV_DATA_SIGNALBASE_HPP
25 #include <condition_variable>
36 #include <libsigrokcxx/libsigrokcxx.hpp>
39 using std::condition_variable;
43 using std::shared_ptr;
60 class SignalBase : public QObject
66 AnalogChannel = 1, ///< Analog data
67 LogicChannel, ///< Logic data
68 DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
69 MathChannel ///< Virtual channel generated by math operations
74 A2LConversionByThreshold = 1,
75 A2LConversionBySchmittTrigger = 2
79 * Conversion presets range from -1 to n, where 1..n are dependent on
80 * the conversion these presets apply to. -1 and 0 have fixed meanings,
83 enum ConversionPreset {
84 NoPreset = -1, ///< Conversion uses custom values
85 DynamicPreset = 0 ///< Conversion uses calculated values
89 static const int ColourBGAlpha;
90 static const uint64_t ConversionBlockSize;
91 static const uint32_t ConversionDelay;
94 SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
95 virtual ~SignalBase();
99 * Returns the underlying SR channel.
101 shared_ptr<sigrok::Channel> channel() const;
104 * Returns enabled status of this channel.
106 bool enabled() const;
109 * Sets the enabled status of this channel.
110 * @param value Boolean value to set.
112 void set_enabled(bool value);
115 * Gets the type of this channel.
117 ChannelType type() const;
120 * Gets the index number of this channel, i.e. a unique ID assigned by
123 unsigned int index() const;
126 * Returns which bit of a given sample for this signal represents the
127 * signal itself. This is relevant for compound signals like logic,
128 * rather meaningless for everything else but provided in case there
129 * is a conversion active that provides a digital signal using bit #0.
131 unsigned int logic_bit_index() const;
134 * Gets the name of this signal.
136 QString name() const;
139 * Gets the internal name of this signal, i.e. how the device calls it.
141 QString internal_name() const;
144 * Sets the name of the signal.
146 virtual void set_name(QString name);
149 * Get the colour of the signal.
151 QColor colour() const;
154 * Set the colour of the signal.
156 void set_colour(QColor colour);
159 * Get the background colour of the signal.
161 QColor bgcolour() const;
164 * Sets the internal data object.
166 void set_data(shared_ptr<pv::data::SignalData> data);
169 * Get the internal data as analog data object in case of analog type.
171 shared_ptr<pv::data::Analog> analog_data() const;
174 * Get the internal data as logic data object in case of logic type.
176 shared_ptr<pv::data::Logic> logic_data() const;
179 * Determines whether a given segment is complete (i.e. end-of-frame has
180 * been seen). It only considers the original data, not the converted data.
182 bool segment_is_complete(uint32_t segment_id) const;
185 * Queries the kind of conversion performed on this channel.
187 ConversionType get_conversion_type() const;
190 * Changes the kind of conversion performed on this channel.
192 * Restarts the conversion.
194 void set_conversion_type(ConversionType t);
197 * Returns all currently known conversion options
199 map<QString, QVariant> get_conversion_options() const;
202 * Sets the value of a particular conversion option
203 * Note: it is not checked whether the option is valid for the
204 * currently conversion. If it's not, it will be silently ignored.
206 * Does not restart the conversion.
208 * @return true if the value is different from before, false otherwise
210 bool set_conversion_option(QString key, QVariant value);
213 * Returns the threshold(s) used for conversions, if applicable.
214 * The resulting thresholds are given for the chosen conversion, so you
215 * can query thresholds also for conversions which aren't currently active.
217 * If you want the thresholds for the currently active conversion,
218 * call it either with NoConversion or no parameter.
220 * @param t the type of conversion to obtain the thresholds for, leave
221 * empty or use NoConversion if you want to query the currently
224 * @param always_custom ignore the currently selected preset and always
225 * return the custom values for this conversion, using 0 if those
228 * @return a list of threshold(s) used by the chosen conversion
230 vector<double> get_conversion_thresholds(
231 const ConversionType t = NoConversion, const bool always_custom=false) const;
234 * Provides all conversion presets available for the currently active
237 * @return a list of description/ID pairs for each preset
239 vector<pair<QString, int> > get_conversion_presets() const;
242 * Determines the ID of the currently used conversion preset, which is only
243 * valid for the currently available conversion presets. It is therefore
244 * suggested to call @ref get_conversion_presets right before calling this.
246 * @return the ID of the currently used conversion preset. -1 if no preset
247 * is used. In that case, a user setting is used instead.
249 ConversionPreset get_current_conversion_preset() const;
252 * Sets the conversion preset to be used.
254 * Does not restart the conversion.
256 * @param id the id of the preset to use
258 void set_conversion_preset(ConversionPreset id);
261 bool is_decode_signal() const;
264 virtual void save_settings(QSettings &settings) const;
266 virtual void restore_settings(QSettings &settings);
268 void start_conversion(bool delayed_start=false);
271 bool conversion_is_a2l() const;
273 uint8_t convert_a2l_threshold(float threshold, float value);
274 uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
275 float value, uint8_t &state);
277 void convert_single_segment(pv::data::AnalogSegment *asegment,
278 pv::data::LogicSegment *lsegment);
279 void conversion_thread_proc();
281 void stop_conversion();
284 void enabled_changed(const bool &value);
286 void name_changed(const QString &name);
288 void colour_changed(const QColor &colour);
290 void conversion_type_changed(const ConversionType t);
292 void samples_cleared();
294 void samples_added(QObject* segment, uint64_t start_sample,
295 uint64_t end_sample);
297 void min_max_changed(float min, float max);
300 void on_samples_cleared();
302 void on_samples_added(QObject* segment, uint64_t start_sample,
303 uint64_t end_sample);
305 void on_min_max_changed(float min, float max);
307 void on_capture_state_changed(int state);
309 void on_delayed_conversion_start();
312 shared_ptr<sigrok::Channel> channel_;
313 ChannelType channel_type_;
314 shared_ptr<pv::data::SignalData> data_;
315 shared_ptr<pv::data::SignalData> converted_data_;
316 ConversionType conversion_type_;
317 map<QString, QVariant> conversion_options_;
319 float min_value_, max_value_;
321 std::thread conversion_thread_;
322 atomic<bool> conversion_interrupt_;
323 mutex conversion_input_mutex_;
324 condition_variable conversion_input_cond_;
325 QTimer delayed_conversion_starter_;
327 QString internal_name_, name_;
328 QColor colour_, bgcolour_;
334 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP