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>
38 #include "segment.hpp"
41 using std::condition_variable;
45 using std::shared_ptr;
63 class SignalBase : public QObject
69 AnalogChannel = 1, ///< Analog data
70 LogicChannel, ///< Logic data
71 DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
72 MathChannel ///< Virtual channel generated by math operations
77 A2LConversionByThreshold = 1,
78 A2LConversionBySchmittTrigger = 2
82 * Conversion presets range from -1 to n, where 1..n are dependent on
83 * the conversion these presets apply to. -1 and 0 have fixed meanings,
86 enum ConversionPreset {
87 NoPreset = -1, ///< Conversion uses custom values
88 DynamicPreset = 0 ///< Conversion uses calculated values
92 static const int ColorBGAlpha;
93 static const uint64_t ConversionBlockSize;
94 static const uint32_t ConversionDelay;
97 SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
98 virtual ~SignalBase();
102 * Returns the underlying SR channel.
104 shared_ptr<sigrok::Channel> channel() const;
107 * Returns enabled status of this channel.
109 bool enabled() const;
112 * Sets the enabled status of this channel.
113 * @param value Boolean value to set.
115 void set_enabled(bool value);
118 * Gets the type of this channel.
120 ChannelType type() const;
123 * Gets the index number of this channel, i.e. a unique ID assigned by
126 unsigned int index() const;
129 * Returns which bit of a given sample for this signal represents the
130 * signal itself. This is relevant for compound signals like logic,
131 * rather meaningless for everything else but provided in case there
132 * is a conversion active that provides a digital signal using bit #0.
134 unsigned int logic_bit_index() const;
137 * Gets the name of this signal.
139 QString name() const;
142 * Gets the internal name of this signal, i.e. how the device calls it.
144 QString internal_name() const;
147 * Produces a string for this signal that can be used for display,
148 * i.e. it contains one or both of the signal/internal names.
150 QString display_name() const;
153 * Sets the name of the signal.
155 virtual void set_name(QString name);
158 * Get the color of the signal.
160 QColor color() const;
163 * Set the color of the signal.
165 void set_color(QColor color);
168 * Get the background color of the signal.
170 QColor bgcolor() const;
173 * Sets the internal data object.
175 void set_data(shared_ptr<pv::data::SignalData> data);
178 * Clears all sample data and removes all associated segments.
180 void clear_sample_data();
183 * Get the internal data as analog data object in case of analog type.
185 shared_ptr<pv::data::Analog> analog_data() const;
188 * Get the internal data as logic data object in case of logic type.
190 shared_ptr<pv::data::Logic> logic_data() const;
193 * Determines whether a given segment is complete (i.e. end-of-frame has
194 * been seen). It only considers the original data, not the converted data.
196 bool segment_is_complete(uint32_t segment_id) const;
199 * Determines whether this signal has any sample data at all.
201 bool has_samples() const;
204 * Returns the sample rate for this signal.
206 virtual double get_samplerate() const;
209 * Queries the kind of conversion performed on this channel.
211 ConversionType get_conversion_type() const;
214 * Changes the kind of conversion performed on this channel.
216 * Restarts the conversion.
218 void set_conversion_type(ConversionType t);
221 * Returns all currently known conversion options
223 map<QString, QVariant> get_conversion_options() const;
226 * Sets the value of a particular conversion option
227 * Note: it is not checked whether the option is valid for the
228 * currently conversion. If it's not, it will be silently ignored.
230 * Does not restart the conversion.
232 * @return true if the value is different from before, false otherwise
234 bool set_conversion_option(QString key, QVariant value);
237 * Returns the threshold(s) used for conversions, if applicable.
238 * The resulting thresholds are given for the chosen conversion, so you
239 * can query thresholds also for conversions which aren't currently active.
241 * If you want the thresholds for the currently active conversion,
242 * call it either with NoConversion or no parameter.
244 * @param t the type of conversion to obtain the thresholds for, leave
245 * empty or use NoConversion if you want to query the currently
248 * @param always_custom ignore the currently selected preset and always
249 * return the custom values for this conversion, using 0 if those
252 * @return a list of threshold(s) used by the chosen conversion
254 vector<double> get_conversion_thresholds(
255 const ConversionType t = NoConversion, const bool always_custom=false) const;
258 * Provides all conversion presets available for the currently active
261 * @return a list of description/ID pairs for each preset
263 vector<pair<QString, int> > get_conversion_presets() const;
266 * Determines the ID of the currently used conversion preset, which is only
267 * valid for the currently available conversion presets. It is therefore
268 * suggested to call @ref get_conversion_presets right before calling this.
270 * @return the ID of the currently used conversion preset. -1 if no preset
271 * is used. In that case, a user setting is used instead.
273 ConversionPreset get_current_conversion_preset() const;
276 * Sets the conversion preset to be used.
278 * Does not restart the conversion.
280 * @param id the id of the preset to use
282 void set_conversion_preset(ConversionPreset id);
285 bool is_decode_signal() const;
288 virtual void save_settings(QSettings &settings) const;
290 virtual void restore_settings(QSettings &settings);
292 void start_conversion(bool delayed_start=false);
295 bool conversion_is_a2l() const;
297 uint8_t convert_a2l_threshold(float threshold, float value);
298 uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
299 float value, uint8_t &state);
301 void convert_single_segment_range(AnalogSegment *asegment,
302 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample);
303 void convert_single_segment(pv::data::AnalogSegment *asegment,
304 pv::data::LogicSegment *lsegment);
305 void conversion_thread_proc();
307 void stop_conversion();
310 void enabled_changed(const bool &value);
312 void name_changed(const QString &name);
314 void color_changed(const QColor &color);
316 void conversion_type_changed(const ConversionType t);
318 void samples_cleared();
320 void samples_added(uint64_t segment_id, uint64_t start_sample,
321 uint64_t end_sample);
323 void min_max_changed(float min, float max);
326 void on_samples_cleared();
328 void on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
329 uint64_t end_sample);
331 void on_min_max_changed(float min, float max);
333 void on_capture_state_changed(int state);
335 void on_delayed_conversion_start();
338 shared_ptr<sigrok::Channel> channel_;
339 ChannelType channel_type_;
340 shared_ptr<pv::data::SignalData> data_;
341 shared_ptr<pv::data::SignalData> converted_data_;
342 ConversionType conversion_type_;
343 map<QString, QVariant> conversion_options_;
345 float min_value_, max_value_;
347 std::thread conversion_thread_;
348 atomic<bool> conversion_interrupt_;
349 mutex conversion_input_mutex_;
350 condition_variable conversion_input_cond_;
351 QTimer delayed_conversion_starter_;
353 QString internal_name_, name_;
354 QColor color_, bgcolor_;
360 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP