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         static const unsigned int DecodeNotifyPeriod;
  83
  84 public:
  85         DecodeSignal(pv::Session &session);
  86         virtual ~DecodeSignal();
  87
  88         bool is_decode_signal() const;
  89         const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;
  90
  91         void stack_decoder(srd_decoder *decoder);
  92         void remove_decoder(int index);
  93         bool toggle_decoder_visibility(int index);
  94
  95         void reset_decode();
  96         void begin_decode();
  97         QString error_message() const;
  98
  99         const vector<data::DecodeChannel> get_channels() const;
 100         void auto_assign_signals();
 101         void assign_signal(const uint16_t channel_id, const SignalBase *signal);
 102         int get_assigned_signal_count() const;
 103
 104         void set_initial_pin_state(const uint16_t channel_id, const int init_state);
 105
 106         double samplerate() const;
 107         const pv::util::Timestamp& start_time() const;
 108
 109         /**
 110          * Returns the number of samples that can be worked on,
 111          * i.e. the number of samples where samples are available
 112          * for all connected channels.
 113          */
 114         int64_t get_working_sample_count() const;
 115
 116         int64_t get_decoded_sample_count() const;
 117
 118         vector<decode::Row> visible_rows() const;
 119
 120         /**
 121          * Extracts sorted annotations between two period into a vector.
 122          */
 123         void get_annotation_subset(
 124                 vector<pv::data::decode::Annotation> &dest,
 125                 const decode::Row &row, uint64_t start_sample,
 126                 uint64_t end_sample) const;
 127
 128         virtual void save_settings(QSettings &settings) const;
 129
 130         virtual void restore_settings(QSettings &settings);
 131
 132         /**
 133          * Helper function for static annotation_callback(),
 134          * must be public so the function can access it.
 135          * Don't use from outside this class.
 136          */
 137         uint64_t inc_annotation_count();
 138
 139 private:
 140         void update_channel_list();
 141
 142         void commit_decoder_channels();
 143
 144         void mux_logic_samples(const int64_t start, const int64_t end);
 145
 146         void logic_mux_proc();
 147
 148         void query_input_metadata();
 149
 150         void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count);
 151
 152         void decode_proc();
 153
 154         void start_srd_session();
 155         void stop_srd_session();
 156
 157         void connect_input_notifiers();
 158
 159         static void annotation_callback(srd_proto_data *pdata, void *decode_signal);
 160
 161 Q_SIGNALS:
 162         void new_annotations();
 163         void channels_updated();
 164
 165 private Q_SLOTS:
 166         void on_capture_state_changed(int state);
 167         void on_data_received();
 168
 169 private:
 170         pv::Session &session_;
 171
 172         vector<data::DecodeChannel> channels_;
 173
 174         struct srd_session *srd_session_;
 175
 176         shared_ptr<Logic> logic_mux_data_;
 177         shared_ptr<LogicSegment> segment_;
 178         bool logic_mux_data_invalid_;
 179
 180         pv::util::Timestamp start_time_;
 181         double samplerate_;
 182
 183         int64_t annotation_count_, samples_decoded_;
 184
 185         vector< shared_ptr<decode::Decoder> > stack_;
 186         map<const decode::Row, decode::RowData> rows_;
 187         map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
 188
 189         /**
 190          * This mutex prevents more than one thread from accessing
 191          * libsigrokdecode concurrently.
 192          * @todo A proper solution should be implemented to allow multiple
 193          * decode operations in parallel.
 194          */
 195         static mutex global_srd_mutex_;
 196
 197         mutable mutex input_mutex_, output_mutex_, logic_mux_mutex_;
 198         mutable condition_variable decode_input_cond_, logic_mux_cond_;
 199         bool frame_complete_;
 200
 201         std::thread decode_thread_, logic_mux_thread_;
 202         atomic<bool> decode_interrupt_, logic_mux_interrupt_;
 203
 204         QString error_message_;
 205 };
 206
 207 } // namespace data
 208 } // namespace pv
 209
 210 #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP