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