signalbase.hpp

Go to the documentation of this file.

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_DATA_SIGNALBASE_HPP
#define PULSEVIEW_PV_DATA_SIGNALBASE_HPP

#include <atomic>
#include <deque>
#include <condition_variable>
#include <thread>
#include <vector>

#include <QColor>
#include <QObject>
#include <QSettings>
#include <QString>
#include <QTimer>
#include <QVariant>

#include <libsigrokcxx/libsigrokcxx.hpp>

#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;
}

namespace pv {
namespace data {

class Analog;
class AnalogSegment;
class DecoderStack;
class Logic;
class LogicSegment;
class Segment;
class SignalBase;
class SignalData;

class SignalGroup : public QObject
{
    Q_OBJECT

public:
    SignalGroup(const QString& name);

    void append_signal(shared_ptr<SignalBase> signal);
    void remove_signal(shared_ptr<SignalBase> signal);
    deque<shared_ptr<SignalBase>> signals() const;
    void clear();

    const QString name() const;

private:
    deque<shared_ptr<SignalBase>> signals_;
    QString name_;
};


class SignalBase : public QObject, public enable_shared_from_this<SignalBase>
{
    Q_OBJECT
    Q_PROPERTY(QString error_message READ get_error_message NOTIFY error_message_changed)

public:
    enum ChannelType {
        AnalogChannel = 1, 
        LogicChannel,  
        DecodeChannel, 
        MathChannel    
    };

    enum ConversionType {
        NoConversion = 0,
        A2LConversionByThreshold = 1,
        A2LConversionBySchmittTrigger = 2
    };

    enum ConversionPreset {
        NoPreset = -1,     
        DynamicPreset = 0  
    };

    static const QColor AnalogSignalColors[8];
    static const QColor LogicSignalColors[10];

private:
    static const int ColorBGAlpha;
    static const uint64_t ConversionBlockSize;
    static const uint32_t ConversionDelay;

public:
    SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type);
    virtual ~SignalBase();

public:
    shared_ptr<sigrok::Channel> channel() const;

    bool is_generated() const;

    bool enabled() const;

    void set_enabled(bool value);

    ChannelType type() const;

    unsigned int index() const;

    void set_index(unsigned int index);

    unsigned int logic_bit_index() const;

    void set_group(SignalGroup* group);

    SignalGroup* group() const;

    QString name() const;

    QString internal_name() const;

    void set_internal_name(QString internal_name);

    QString display_name() const;

    virtual void set_name(QString name);

    QColor color() const;

    virtual void set_color(QColor color);

    QColor bgcolor() const;

    virtual QString get_error_message() const;

    void set_data(shared_ptr<pv::data::SignalData> data);

    void clear_sample_data();

    shared_ptr<pv::data::Analog> analog_data() const;

    shared_ptr<pv::data::Logic> logic_data() const;

    shared_ptr<pv::data::SignalData> data() const;

    bool segment_is_complete(uint32_t segment_id) const;

    bool has_samples() const;

    virtual double get_samplerate() const;

    ConversionType get_conversion_type() const;

    void set_conversion_type(ConversionType t);

    map<QString, QVariant> get_conversion_options() const;

    bool set_conversion_option(QString key, QVariant value);

    vector<double> get_conversion_thresholds(
        const ConversionType t = NoConversion, const bool always_custom=false) const;

    vector<pair<QString, int> > get_conversion_presets() const;

    ConversionPreset get_current_conversion_preset() const;

    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);

protected:
    virtual void set_error_message(QString msg);

private:
    void stop_conversion();

    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(shared_ptr<AnalogSegment> asegment,
        shared_ptr<LogicSegment> lsegment, uint64_t start_sample, uint64_t end_sample);
    void convert_single_segment(shared_ptr<AnalogSegment> asegment,
        shared_ptr<LogicSegment> lsegment);
    void conversion_thread_proc();

Q_SIGNALS:
    void enabled_changed(const bool &value);
    void name_changed(const QString &name);
    void color_changed(const QColor &color);
    void error_message_changed(QString msg);
    void conversion_type_changed(const ConversionType t);

    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_input_segment_completed();

    void on_min_max_changed(float min, float max);

    void on_capture_state_changed(int state);

    void on_delayed_conversion_start();

protected:
    shared_ptr<sigrok::Channel> channel_;
    ChannelType channel_type_;
    SignalGroup* group_;
    shared_ptr<pv::data::SignalData> data_;
    shared_ptr<pv::data::SignalData> converted_data_;
    ConversionType conversion_type_;
    map<QString, QVariant> conversion_options_;

    float min_value_, max_value_;

    std::thread conversion_thread_;
    atomic<bool> 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_;

    QString error_message_;
};

} // namespace data
} // namespace pv

Q_DECLARE_METATYPE(shared_ptr<pv::data::SignalBase>);

#endif // PULSEVIEW_PV_DATA_SIGNALBASE_HPP