pv/data/decodesignal.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2017 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_DECODESIGNAL_HPP
  21 #define PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
  22
  23 #include <atomic>
  24 #include <condition_variable>
  25 #include <unordered_set>
  26 #include <vector>
  27
  28 #include <QSettings>
  29 #include <QString>
  30
  31 #include <libsigrokdecode/libsigrokdecode.h>
  32
  33 #include <pv/data/decode/row.hpp>
  34 #include <pv/data/decode/rowdata.hpp>
  35 #include <pv/data/signalbase.hpp>
  36 #include <pv/util.hpp>
  37
  38 using std::atomic;
  39 using std::condition_variable;
  40 using std::map;
  41 using std::mutex;
  42 using std::pair;
  43 using std::unordered_set;
  44 using std::vector;
  45 using std::shared_ptr;
  46
  47 namespace pv {
  48 class Session;
  49
  50 namespace data {
  51
  52 namespace decode {
  53 class Annotation;
  54 class Decoder;
  55 class Row;
  56 }
  57
  58 class Logic;
  59 class LogicSegment;
  60 class SignalBase;
  61 class SignalData;
  62
  63 struct DecodeChannel
  64 {
  65         uint16_t id;  // Also tells which bit within a sample represents this channel
  66         const bool is_optional;
  67         const pv::data::SignalBase *assigned_signal;
  68         const QString name, desc;
  69         int initial_pin_state;
  70         const shared_ptr<pv::data::decode::Decoder> decoder_;
  71         const srd_channel *pdch_;
  72 };
  73
  74 class DecodeSignal : public SignalBase
  75 {
  76         Q_OBJECT
  77
  78 private:
  79         static const double DecodeMargin;
  80         static const double DecodeThreshold;
  81         static const int64_t DecodeChunkLength;
  82
  83 public:
  84         DecodeSignal(pv::Session &session);
  85         virtual ~DecodeSignal();
  86
  87         bool is_decode_signal() const;
  88         const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;
  89
  90         void stack_decoder(const srd_decoder *decoder);
  91         void remove_decoder(int index);
  92         bool toggle_decoder_visibility(int index);
  93
  94         void reset_decode();
  95         void begin_decode();
  96         QString error_message() const;
  97
  98         const vector<data::DecodeChannel> get_channels() const;
  99         void auto_assign_signals();
 100         void assign_signal(const uint16_t channel_id, const SignalBase *signal);
 101         int get_assigned_signal_count() const;
 102
 103         void set_initial_pin_state(const uint16_t channel_id, const int init_state);
 104
 105         double samplerate() const;
 106         const pv::util::Timestamp& start_time() const;
 107
 108         /**
 109          * Returns the number of samples that can be worked on,
 110          * i.e. the number of samples where samples are available
 111          * for all connected channels.
 112          */
 113         int64_t get_working_sample_count() const;
 114
 115         int64_t get_decoded_sample_count() const;
 116
 117         vector<decode::Row> visible_rows() const;
 118
 119         /**
 120          * Extracts sorted annotations between two period into a vector.
 121          */
 122         void get_annotation_subset(
 123                 vector<pv::data::decode::Annotation> &dest,
 124                 const decode::Row &row, uint64_t start_sample,
 125                 uint64_t end_sample) const;
 126
 127         virtual void save_settings(QSettings &settings) const;
 128
 129         virtual void restore_settings(QSettings &settings);
 130
 131 private:
 132         void update_channel_list();
 133
 134         void commit_decoder_channels();
 135
 136         void mux_logic_samples(const int64_t start, const int64_t end);
 137
 138         void logic_mux_proc();
 139
 140         void query_input_metadata();
 141
 142         void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count);
 143
 144         void decode_proc();
 145
 146         void start_srd_session();
 147         void stop_srd_session();
 148
 149         void connect_input_notifiers();
 150
 151         static void annotation_callback(srd_proto_data *pdata, void *decode_signal);
 152
 153 Q_SIGNALS:
 154         void new_annotations();
 155         void decode_finished();
 156         void channels_updated();
 157
 158 private Q_SLOTS:
 159         void on_capture_state_changed(int state);
 160         void on_data_cleared();
 161         void on_data_received();
 162
 163 private:
 164         pv::Session &session_;
 165
 166         vector<data::DecodeChannel> channels_;
 167
 168         struct srd_session *srd_session_;
 169
 170         shared_ptr<Logic> logic_mux_data_;
 171         shared_ptr<LogicSegment> segment_;
 172         bool logic_mux_data_invalid_;
 173
 174         pv::util::Timestamp start_time_;
 175         double samplerate_;
 176
 177         int64_t samples_decoded_;
 178
 179         vector< shared_ptr<decode::Decoder> > stack_;
 180         map<const decode::Row, decode::RowData> rows_;
 181         map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
 182
 183         /**
 184          * This mutex prevents more than one thread from accessing
 185          * libsigrokdecode concurrently.
 186          * @todo A proper solution should be implemented to allow multiple
 187          * decode operations in parallel.
 188          */
 189         static mutex global_srd_mutex_;
 190
 191         mutable mutex input_mutex_, output_mutex_, logic_mux_mutex_;
 192         mutable condition_variable decode_input_cond_, logic_mux_cond_;
 193         bool frame_complete_;
 194
 195         std::thread decode_thread_, logic_mux_thread_;
 196         atomic<bool> decode_interrupt_, logic_mux_interrupt_;
 197
 198         QString error_message_;
 199 };
 200
 201 } // namespace data
 202 } // namespace pv
 203
 204 #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP