pv/data/mathsignal.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_DATA_MATHSIGNAL_HPP
  21 #define PULSEVIEW_PV_DATA_MATHSIGNAL_HPP
  22
  23 #include <limits>
  24
  25 #include <QString>
  26
  27 #include <pv/exprtk.hpp>
  28 #include <pv/util.hpp>
  29 #include <pv/data/analog.hpp>
  30 #include <pv/data/signalbase.hpp>
  31
  32 using std::atomic;
  33 using std::condition_variable;
  34 using std::mutex;
  35 using std::numeric_limits;
  36 using std::shared_ptr;
  37
  38 namespace pv {
  39 class Session;
  40
  41 namespace data {
  42
  43 class SignalBase;
  44
  45 template<typename T>
  46 struct sig_sample;
  47
  48 struct signal_data {
  49         signal_data(const shared_ptr<SignalBase> _sb) :
  50                 sb(_sb), sample_num(numeric_limits<uint64_t>::max()), sample_value(0), ref(nullptr)
  51         {}
  52
  53         const shared_ptr<SignalBase> sb;
  54         uint64_t sample_num;
  55         double sample_value;
  56         double* ref;
  57 };
  58
  59 class MathSignal : public SignalBase
  60 {
  61         Q_OBJECT
  62         Q_PROPERTY(QString expression READ get_expression WRITE set_expression NOTIFY expression_changed)
  63         Q_PROPERTY(QString error_message READ error_message)
  64
  65 private:
  66         static const int64_t ChunkLength;
  67
  68 public:
  69         MathSignal(pv::Session &session);
  70         virtual ~MathSignal();
  71
  72         virtual void save_settings(QSettings &settings) const;
  73         virtual void restore_settings(QSettings &settings);
  74
  75         QString error_message() const;
  76
  77         QString get_expression() const;
  78         void set_expression(QString expression);
  79
  80 private:
  81         void set_error_message(QString msg);
  82
  83         /**
  84          * Returns the number of samples that can be worked on,
  85          * i.e. the number of samples where samples are available
  86          * for all connected channels.
  87          * If the math signal uses no input channels, this is the
  88          * number of samples in the session.
  89          */
  90         uint64_t get_working_sample_count(uint32_t segment_id) const;
  91
  92         void update_completeness(uint32_t segment_id);
  93
  94         void reset_generation();
  95         void begin_generation();
  96
  97         void generate_samples(uint32_t segment_id, const uint64_t start_sample,
  98                 const int64_t sample_count);
  99         void generation_proc();
 100
 101         signal_data* signal_from_name(const std::string& name);
 102         void update_signal_sample(signal_data* sig_data, uint32_t segment_id, uint64_t sample_num);
 103
 104 Q_SIGNALS:
 105         void samples_cleared();
 106
 107         void samples_added(uint64_t segment_id, uint64_t start_sample,
 108                 uint64_t end_sample);
 109
 110         void min_max_changed(float min, float max);
 111
 112         void expression_changed(QString expression);
 113
 114 private Q_SLOTS:
 115         void on_capture_state_changed(int state);
 116         void on_data_received();
 117
 118 private:
 119         pv::Session &session_;
 120
 121         uint64_t custom_sample_rate_;
 122         uint64_t custom_sample_count_;
 123         bool use_custom_sample_rate_, use_custom_sample_count_;
 124         map<std::string, signal_data> input_signals_;
 125
 126         QString expression_, error_message_;
 127
 128         mutable mutex input_mutex_;
 129         mutable condition_variable gen_input_cond_;
 130
 131         std::thread gen_thread_;
 132         atomic<bool> gen_interrupt_;
 133
 134         exprtk::symbol_table<double> *exprtk_unknown_symbol_table_, *exprtk_symbol_table_;
 135         exprtk::expression<double> *exprtk_expression_;
 136         exprtk::parser<double> *exprtk_parser_;
 137         double exprtk_current_time_, exprtk_current_sample_;
 138
 139         sig_sample<double>* fnc_sig_sample_;
 140
 141         // Give sig_sample access to the private helper functions
 142         friend struct sig_sample<double>;
 143 };
 144
 145 } // namespace data
 146 } // namespace pv
 147
 148 #endif // PULSEVIEW_PV_DATA_MATHSIGNAL_HPP