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