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
26 #include <condition_variable>
37 #include <libsigrokcxx/libsigrokcxx.hpp>
39 #include "segment.hpp"
42 using std::condition_variable;
44 using std::enable_shared_from_this;
48 using std::shared_ptr;
67 class SignalGroup : public QObject
72 SignalGroup(const QString& name);
74 void append_signal(shared_ptr<SignalBase> signal);
75 void remove_signal(shared_ptr<SignalBase> signal);
76 deque<shared_ptr<SignalBase>> signals() const;
79 const QString name() const;
82 deque<shared_ptr<SignalBase>> signals_;
87 class SignalBase : public QObject, public enable_shared_from_this<SignalBase>
93 AnalogChannel = 1, ///< Analog data
94 LogicChannel, ///< Logic data
95 DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode
96 MathChannel ///< Virtual channel generated by math operations
101 A2LConversionByThreshold = 1,
102 A2LConversionBySchmittTrigger = 2
106 * Conversion presets range from -1 to n, where 1..n are dependent on
107 * the conversion these presets apply to. -1 and 0 have fixed meanings,
110 enum ConversionPreset {
111 NoPreset = -1, ///< Conversion uses custom values
112 DynamicPreset = 0 ///< Conversion uses calculated values
116 static const int ColorBGAlpha;
117 static const uint64_t ConversionBlockSize;
118 static const uint32_t ConversionDelay;
121 SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
122 virtual ~SignalBase();
126 * Returns the underlying SR channel.
127 * Generated channels don't have a SR channel.
129 shared_ptr<sigrok::Channel> channel() const;
132 * Returns enabled status of this channel.
134 bool enabled() const;
137 * Sets the enabled status of this channel.
138 * @param value Boolean value to set.
140 void set_enabled(bool value);
143 * Gets the type of this channel.
145 ChannelType type() const;
148 * Gets the index number of this channel, i.e. a unique ID assigned by
151 unsigned int index() const;
154 * Sets the index number of this channel, i.e. a unique ID assigned by
155 * the device driver or the logic bit index (see below).
156 * Only use immediately after creating the signal and leave it untouched after.
158 void set_index(unsigned int index);
161 * Returns which bit of a given sample for this signal represents the
162 * signal itself. This is relevant for compound signals like logic,
163 * rather meaningless for everything else but provided in case there
164 * is a conversion active that provides a digital signal using bit #0.
166 unsigned int logic_bit_index() const;
169 * Sets the signal group this signal belongs to
171 void set_group(SignalGroup* group);
174 * Returns the signal group this signal belongs to or nullptr if none
176 SignalGroup* group() const;
179 * Gets the name of this signal.
181 QString name() const;
184 * Gets the internal name of this signal, i.e. how the device/generator calls it.
186 QString internal_name() const;
189 * Sets the internal name of this signal, i.e. how the device/generator calls it.
190 * Only use immediately after creating the signal and leave it untouched after.
192 void set_internal_name(QString internal_name);
195 * Produces a string for this signal that can be used for display,
196 * i.e. it contains one or both of the signal/internal names.
198 QString display_name() const;
201 * Sets the name of the signal.
203 virtual void set_name(QString name);
206 * Get the color of the signal.
208 QColor color() const;
211 * Set the color of the signal.
213 void set_color(QColor color);
216 * Get the background color of the signal.
218 QColor bgcolor() const;
221 * Sets the internal data object.
223 void set_data(shared_ptr<pv::data::SignalData> data);
226 * Clears all sample data and removes all associated segments.
228 void clear_sample_data();
231 * Get the internal data as analog data object in case of analog type.
233 shared_ptr<pv::data::Analog> analog_data() const;
236 * Get the internal data as logic data object in case of logic type.
238 shared_ptr<pv::data::Logic> logic_data() const;
241 * Determines whether a given segment is complete (i.e. end-of-frame has
242 * been seen). It only considers the original data, not the converted data.
244 bool segment_is_complete(uint32_t segment_id) const;
247 * Determines whether this signal has any sample data at all.
249 bool has_samples() const;
252 * Returns the sample rate for this signal.
254 virtual double get_samplerate() const;
257 * Queries the kind of conversion performed on this channel.
259 ConversionType get_conversion_type() const;
262 * Changes the kind of conversion performed on this channel.
264 * Restarts the conversion.
266 void set_conversion_type(ConversionType t);
269 * Returns all currently known conversion options
271 map<QString, QVariant> get_conversion_options() const;
274 * Sets the value of a particular conversion option
275 * Note: it is not checked whether the option is valid for the
276 * currently conversion. If it's not, it will be silently ignored.
278 * Does not restart the conversion.
280 * @return true if the value is different from before, false otherwise
282 bool set_conversion_option(QString key, QVariant value);
285 * Returns the threshold(s) used for conversions, if applicable.
286 * The resulting thresholds are given for the chosen conversion, so you
287 * can query thresholds also for conversions which aren't currently active.
289 * If you want the thresholds for the currently active conversion,
290 * call it either with NoConversion or no parameter.
292 * @param t the type of conversion to obtain the thresholds for, leave
293 * empty or use NoConversion if you want to query the currently
296 * @param always_custom ignore the currently selected preset and always
297 * return the custom values for this conversion, using 0 if those
300 * @return a list of threshold(s) used by the chosen conversion
302 vector<double> get_conversion_thresholds(
303 const ConversionType t = NoConversion, const bool always_custom=false) const;
306 * Provides all conversion presets available for the currently active
309 * @return a list of description/ID pairs for each preset
311 vector<pair<QString, int> > get_conversion_presets() const;
314 * Determines the ID of the currently used conversion preset, which is only
315 * valid for the currently available conversion presets. It is therefore
316 * suggested to call @ref get_conversion_presets right before calling this.
318 * @return the ID of the currently used conversion preset. -1 if no preset
319 * is used. In that case, a user setting is used instead.
321 ConversionPreset get_current_conversion_preset() const;
324 * Sets the conversion preset to be used.
326 * Does not restart the conversion.
328 * @param id the id of the preset to use
330 void set_conversion_preset(ConversionPreset id);
333 bool is_decode_signal() const;
336 virtual void save_settings(QSettings &settings) const;
338 virtual void restore_settings(QSettings &settings);
340 void start_conversion(bool delayed_start=false);
343 bool conversion_is_a2l() const;
345 uint8_t convert_a2l_threshold(float threshold, float value);
346 uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
347 float value, uint8_t &state);
349 void convert_single_segment_range(AnalogSegment *asegment,
350 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample);
351 void convert_single_segment(pv::data::AnalogSegment *asegment,
352 pv::data::LogicSegment *lsegment);
353 void conversion_thread_proc();
355 void stop_conversion();
358 void enabled_changed(const bool &value);
360 void name_changed(const QString &name);
362 void color_changed(const QColor &color);
364 void conversion_type_changed(const ConversionType t);
366 void samples_cleared();
368 void samples_added(uint64_t segment_id, uint64_t start_sample,
369 uint64_t end_sample);
371 void min_max_changed(float min, float max);
374 void on_samples_cleared();
376 void on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
377 uint64_t end_sample);
379 void on_min_max_changed(float min, float max);
381 void on_capture_state_changed(int state);
383 void on_delayed_conversion_start();
386 shared_ptr<sigrok::Channel> channel_;
387 ChannelType channel_type_;
389 shared_ptr<pv::data::SignalData> data_;
390 shared_ptr<pv::data::SignalData> converted_data_;
391 ConversionType conversion_type_;
392 map<QString, QVariant> conversion_options_;
394 float min_value_, max_value_;
396 std::thread conversion_thread_;
397 atomic<bool> conversion_interrupt_;
398 mutex conversion_input_mutex_;
399 condition_variable conversion_input_cond_;
400 QTimer delayed_conversion_starter_;
402 QString internal_name_, name_;
403 QColor color_, bgcolor_;
410 #endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP