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