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::vector;
  44 using std::shared_ptr;
  45
  46 namespace pv {
  47 class Session;
  48
  49 namespace data {
  50
  51 namespace decode {
  52 class Annotation;
  53 class Decoder;
  54 class Row;
  55 }
  56
  57 class Logic;
  58 class LogicSegment;
  59 class SignalBase;
  60 class SignalData;
  61
  62 struct DecodeChannel
  63 {
  64         uint16_t id;     ///< Global numerical ID for the decode channels in the stack
  65         uint16_t bit_id; ///< 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 struct DecodeBinaryData
  75 {
  76         vector<uint8_t> data;
  77         uint64_t sample;   ///< Number of the sample where this data was provided by the PD
  78 };
  79
  80 struct DecodeSegment
  81 {
  82         map<const decode::Row, decode::RowData> annotation_rows;
  83         pv::util::Timestamp start_time;
  84         double samplerate;
  85         int64_t samples_decoded_incl, samples_decoded_excl;
  86         vector<DecodeBinaryData> binary_data;
  87 };
  88
  89 class DecodeSignal : public SignalBase
  90 {
  91         Q_OBJECT
  92
  93 private:
  94         static const double DecodeMargin;
  95         static const double DecodeThreshold;
  96         static const int64_t DecodeChunkLength;
  97
  98 public:
  99         DecodeSignal(pv::Session &session);
 100         virtual ~DecodeSignal();
 101
 102         bool is_decode_signal() const;
 103         const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;
 104
 105         void stack_decoder(const srd_decoder *decoder);
 106         void remove_decoder(int index);
 107         bool toggle_decoder_visibility(int index);
 108
 109         void reset_decode(bool shutting_down = false);
 110         void begin_decode();
 111         void pause_decode();
 112         void resume_decode();
 113         bool is_paused() const;
 114         QString error_message() const;
 115
 116         const vector<data::DecodeChannel> get_channels() const;
 117         void auto_assign_signals(const shared_ptr<pv::data::decode::Decoder> dec);
 118         void assign_signal(const uint16_t channel_id, const SignalBase *signal);
 119         int get_assigned_signal_count() const;
 120
 121         void set_initial_pin_state(const uint16_t channel_id, const int init_state);
 122
 123         double samplerate() const;
 124         const pv::util::Timestamp start_time() const;
 125
 126         /**
 127          * Returns the number of samples that can be worked on,
 128          * i.e. the number of samples where samples are available
 129          * for all connected channels.
 130          */
 131         int64_t get_working_sample_count(uint32_t segment_id) const;
 132
 133         /**
 134          * Returns the number of processed samples. Newly generated annotations will
 135          * have sample numbers greater than this.
 136          *
 137          * If include_processing is true, this number will include the ones being
 138          * currently processed (in case the decoder stack is running). In this case,
 139          * newly generated annotations will have sample numbers smaller than this.
 140          */
 141         int64_t get_decoded_sample_count(uint32_t segment_id,
 142                 bool include_processing) const;
 143
 144         vector<decode::Row> get_rows(bool visible_only) const;
 145
 146         /**
 147          * Extracts annotations from a single row into a vector.
 148          * Note: The annotations may be unsorted and only annotations that fully
 149          * fit into the sample range are considered.
 150          */
 151         void get_annotation_subset(
 152                 vector<pv::data::decode::Annotation> &dest,
 153                 const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
 154                 uint64_t end_sample) const;
 155
 156         /**
 157          * Extracts annotations from all rows into a vector.
 158          * Note: The annotations may be unsorted and only annotations that fully
 159          * fit into the sample range are considered.
 160          */
 161         void get_annotation_subset(
 162                 vector<pv::data::decode::Annotation> &dest,
 163                 uint32_t segment_id, uint64_t start_sample, uint64_t end_sample) const;
 164
 165         uint32_t get_binary_data_chunk_count(uint32_t segment_id) const;
 166         void get_binary_data_chunk(uint32_t segment_id, uint32_t chunk_id,
 167                 const vector<uint8_t> **dest, uint64_t *size);
 168         void get_binary_data_chunks_merged(uint32_t segment_id,
 169                 uint64_t start_sample, uint64_t end_sample, vector<uint8_t> *dest) const;
 170
 171         virtual void save_settings(QSettings &settings) const;
 172
 173         virtual void restore_settings(QSettings &settings);
 174
 175 private:
 176         void set_error_message(QString msg);
 177
 178         uint32_t get_input_segment_count() const;
 179
 180         uint32_t get_input_samplerate(uint32_t segment_id) const;
 181
 182         void update_channel_list();
 183
 184         void commit_decoder_channels();
 185
 186         void mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end);
 187
 188         void logic_mux_proc();
 189
 190         void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count,
 191                 const shared_ptr<LogicSegment> input_segment);
 192
 193         void decode_proc();
 194
 195         void start_srd_session();
 196         void terminate_srd_session();
 197         void stop_srd_session();
 198
 199         void connect_input_notifiers();
 200
 201         void create_decode_segment();
 202
 203         static void annotation_callback(srd_proto_data *pdata, void *decode_signal);
 204         static void binary_callback(srd_proto_data *pdata, void *decode_signal);
 205
 206 Q_SIGNALS:
 207         void new_annotations(); // TODO Supply segment for which they belong to
 208         void new_binary_data(uint32_t segment_id);
 209         void decode_reset();
 210         void decode_finished();
 211         void channels_updated();
 212
 213 private Q_SLOTS:
 214         void on_capture_state_changed(int state);
 215         void on_data_cleared();
 216         void on_data_received();
 217
 218 private:
 219         pv::Session &session_;
 220
 221         vector<data::DecodeChannel> channels_;
 222
 223         struct srd_session *srd_session_;
 224
 225         shared_ptr<Logic> logic_mux_data_;
 226         uint32_t logic_mux_unit_size_;
 227         bool logic_mux_data_invalid_;
 228
 229         vector< shared_ptr<decode::Decoder> > stack_;
 230         bool stack_config_changed_;
 231         map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
 232
 233         vector<DecodeSegment> segments_;
 234         uint32_t current_segment_id_;
 235
 236         mutable mutex input_mutex_, output_mutex_, decode_pause_mutex_, logic_mux_mutex_;
 237         mutable condition_variable decode_input_cond_, decode_pause_cond_,
 238                 logic_mux_cond_;
 239
 240         std::thread decode_thread_, logic_mux_thread_;
 241         atomic<bool> decode_interrupt_, logic_mux_interrupt_;
 242
 243         bool decode_paused_;
 244
 245         QString error_message_;
 246 };
 247
 248 } // namespace data
 249 } // namespace pv
 250
 251 #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP