X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fdata%2Fsignalbase.hpp;h=5a35218f3a2501e87d5e27ef8656532f27191e74;hp=ca3cd5c47c8b0489490c65a66905cc0c000c3a47;hb=4640a84e926ac4b82e2a1b6ef9fc80ef44c2bd3c;hpb=cbd2a2de848f957507096785d3be1cc97d30df9a diff --git a/pv/data/signalbase.hpp b/pv/data/signalbase.hpp index ca3cd5c4..5a35218f 100644 --- a/pv/data/signalbase.hpp +++ b/pv/data/signalbase.hpp @@ -15,48 +15,123 @@ * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + * along with this program; if not, see . */ #ifndef PULSEVIEW_PV_DATA_SIGNALBASE_HPP #define PULSEVIEW_PV_DATA_SIGNALBASE_HPP +#include +#include +#include +#include +#include + #include #include +#include #include +#include +#include #include +#include "segment.hpp" + +using std::atomic; +using std::condition_variable; +using std::deque; +using std::enable_shared_from_this; +using std::map; +using std::mutex; +using std::pair; +using std::shared_ptr; +using std::vector; namespace sigrok { class Channel; -class ChannelType; } namespace pv { namespace data { class Analog; +class AnalogSegment; +class DecoderStack; class Logic; +class LogicSegment; +class Segment; +class SignalBase; class SignalData; -class SignalBase : public QObject +class SignalGroup : public QObject { Q_OBJECT +public: + SignalGroup(const QString& name); + + void append_signal(shared_ptr signal); + void remove_signal(shared_ptr signal); + deque> signals() const; + void clear(); + + const QString name() const; + private: - static const int ColourBGAlpha; + deque> signals_; + QString name_; +}; + + +class SignalBase : public QObject, public enable_shared_from_this +{ + Q_OBJECT public: - SignalBase(std::shared_ptr channel); - virtual ~SignalBase() {} + enum ChannelType { + AnalogChannel = 1, ///< Analog data + LogicChannel, ///< Logic data + DecodeChannel, ///< Protocol Decoder channel using libsigrokdecode + MathChannel ///< Virtual channel generated by math operations + }; + + enum ConversionType { + NoConversion = 0, + A2LConversionByThreshold = 1, + A2LConversionBySchmittTrigger = 2 + }; + + /** + * Conversion presets range from -1 to n, where 1..n are dependent on + * the conversion these presets apply to. -1 and 0 have fixed meanings, + * however. + */ + enum ConversionPreset { + NoPreset = -1, ///< Conversion uses custom values + DynamicPreset = 0 ///< Conversion uses calculated values + }; + +private: + static const int ColorBGAlpha; + static const uint64_t ConversionBlockSize; + static const uint32_t ConversionDelay; + +public: + SignalBase(shared_ptr channel, ChannelType channel_type); + virtual ~SignalBase(); public: /** * Returns the underlying SR channel. + * Generated channels don't have a SR channel. + */ + shared_ptr channel() const; + + /** + * Returns whether this channel is generated or a channel associated with the device. */ - std::shared_ptr channel() const; + bool is_generated() const; /** * Returns enabled status of this channel. @@ -72,67 +147,265 @@ public: /** * Gets the type of this channel. */ - const sigrok::ChannelType *type() const; + ChannelType type() const; /** - * Gets the index number of this channel. + * Gets the index number of this channel, i.e. a unique ID assigned by + * the device driver. */ unsigned int index() const; + /** + * Sets the index number of this channel, i.e. a unique ID assigned by + * the device driver or the logic bit index (see below). + * Only use immediately after creating the signal and leave it untouched after. + */ + void set_index(unsigned int index); + + /** + * Returns which bit of a given sample for this signal represents the + * signal itself. This is relevant for compound signals like logic, + * rather meaningless for everything else but provided in case there + * is a conversion active that provides a digital signal using bit #0. + */ + unsigned int logic_bit_index() const; + + /** + * Sets the signal group this signal belongs to + */ + void set_group(SignalGroup* group); + + /** + * Returns the signal group this signal belongs to or nullptr if none + */ + SignalGroup* group() const; + /** * Gets the name of this signal. */ QString name() const; + /** + * Gets the internal name of this signal, i.e. how the device/generator calls it. + */ + QString internal_name() const; + + /** + * Sets the internal name of this signal, i.e. how the device/generator calls it. + * Only use immediately after creating the signal and leave it untouched after. + */ + void set_internal_name(QString internal_name); + + /** + * Produces a string for this signal that can be used for display, + * i.e. it contains one or both of the signal/internal names. + */ + QString display_name() const; + /** * Sets the name of the signal. */ virtual void set_name(QString name); /** - * Get the colour of the signal. + * Get the color of the signal. */ - QColor colour() const; + QColor color() const; /** - * Set the colour of the signal. + * Set the color of the signal. */ - void set_colour(QColor colour); + void set_color(QColor color); /** - * Get the background colour of the signal. + * Get the background color of the signal. */ - QColor bgcolour() const; + QColor bgcolor() const; /** * Sets the internal data object. */ - void set_data(std::shared_ptr data); + void set_data(shared_ptr data); + + /** + * Clears all sample data and removes all associated segments. + */ + void clear_sample_data(); /** * Get the internal data as analog data object in case of analog type. */ - std::shared_ptr analog_data() const; + shared_ptr analog_data() const; /** * Get the internal data as logic data object in case of logic type. */ - std::shared_ptr logic_data() const; + shared_ptr logic_data() const; + + /** + * Determines whether a given segment is complete (i.e. end-of-frame has + * been seen). It only considers the original data, not the converted data. + */ + bool segment_is_complete(uint32_t segment_id) const; + /** + * Determines whether this signal has any sample data at all. + */ + bool has_samples() const; + + /** + * Returns the sample rate for this signal. + */ + virtual double get_samplerate() const; + + /** + * Queries the kind of conversion performed on this channel. + */ + ConversionType get_conversion_type() const; + + /** + * Changes the kind of conversion performed on this channel. + * + * Restarts the conversion. + */ + void set_conversion_type(ConversionType t); + + /** + * Returns all currently known conversion options + */ + map get_conversion_options() const; + + /** + * Sets the value of a particular conversion option + * Note: it is not checked whether the option is valid for the + * currently conversion. If it's not, it will be silently ignored. + * + * Does not restart the conversion. + * + * @return true if the value is different from before, false otherwise + */ + bool set_conversion_option(QString key, QVariant value); + + /** + * Returns the threshold(s) used for conversions, if applicable. + * The resulting thresholds are given for the chosen conversion, so you + * can query thresholds also for conversions which aren't currently active. + * + * If you want the thresholds for the currently active conversion, + * call it either with NoConversion or no parameter. + * + * @param t the type of conversion to obtain the thresholds for, leave + * empty or use NoConversion if you want to query the currently + * used conversion + * + * @param always_custom ignore the currently selected preset and always + * return the custom values for this conversion, using 0 if those + * aren't set + * + * @return a list of threshold(s) used by the chosen conversion + */ + vector get_conversion_thresholds( + const ConversionType t = NoConversion, const bool always_custom=false) const; + + /** + * Provides all conversion presets available for the currently active + * conversion. + * + * @return a list of description/ID pairs for each preset + */ + vector > get_conversion_presets() const; + + /** + * Determines the ID of the currently used conversion preset, which is only + * valid for the currently available conversion presets. It is therefore + * suggested to call @ref get_conversion_presets right before calling this. + * + * @return the ID of the currently used conversion preset. -1 if no preset + * is used. In that case, a user setting is used instead. + */ + ConversionPreset get_current_conversion_preset() const; + + /** + * Sets the conversion preset to be used. + * + * Does not restart the conversion. + * + * @param id the id of the preset to use + */ + void set_conversion_preset(ConversionPreset id); + +#ifdef ENABLE_DECODE + bool is_decode_signal() const; +#endif + + virtual void save_settings(QSettings &settings) const; + virtual void restore_settings(QSettings &settings); + + void start_conversion(bool delayed_start=false); + +private: + bool conversion_is_a2l() const; + + uint8_t convert_a2l_threshold(float threshold, float value); + uint8_t convert_a2l_schmitt_trigger(float lo_thr, float hi_thr, + float value, uint8_t &state); + + void convert_single_segment_range(AnalogSegment *asegment, + LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample); + void convert_single_segment(pv::data::AnalogSegment *asegment, + pv::data::LogicSegment *lsegment); + void conversion_thread_proc(); + + void stop_conversion(); Q_SIGNALS: void enabled_changed(const bool &value); void name_changed(const QString &name); - void colour_changed(const QColor &colour); + void color_changed(const QColor &color); -private: - std::shared_ptr channel_; - std::shared_ptr data_; + void conversion_type_changed(const ConversionType t); - QString name_; - QColor colour_, bgcolour_; + void samples_cleared(); + + void samples_added(uint64_t segment_id, uint64_t start_sample, + uint64_t end_sample); + + void min_max_changed(float min, float max); + +private Q_SLOTS: + void on_samples_cleared(); + + void on_samples_added(SharedPtrToSegment segment, uint64_t start_sample, + uint64_t end_sample); + + void on_min_max_changed(float min, float max); + + void on_capture_state_changed(int state); + + void on_delayed_conversion_start(); + +protected: + shared_ptr channel_; + ChannelType channel_type_; + SignalGroup* group_; + shared_ptr data_; + shared_ptr converted_data_; + ConversionType conversion_type_; + map conversion_options_; + + float min_value_, max_value_; + + std::thread conversion_thread_; + atomic conversion_interrupt_; + mutex conversion_input_mutex_; + condition_variable conversion_input_cond_; + QTimer delayed_conversion_starter_; + + QString internal_name_, name_; + QColor color_, bgcolor_; + unsigned int index_; }; } // namespace data