DecodeSignal: Allow muxed logic data to be cached

[pulseview.git] / pv / data / decodesignal.hpp

diff --git a/pv/data/decodesignal.hpp b/pv/data/decodesignal.hpp
index 23ab209b73a2faa784806fe5d24b68abd6683e96..29e8441a83785ee62628959d4676791f90456b27 100644 (file)
--- a/pv/data/decodesignal.hpp
+++ b/pv/data/decodesignal.hpp
@@ -20,42 +20,182 @@
 #ifndef PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
 #define PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
 
+#include <atomic>
+#include <condition_variable>
+#include <unordered_set>
+#include <vector>
+
+#include <QSettings>
+#include <QString>
+
 #include <libsigrokdecode/libsigrokdecode.h>
 
+#include <pv/data/decode/row.hpp>
+#include <pv/data/decode/rowdata.hpp>
 #include <pv/data/signalbase.hpp>
+#include <pv/util.hpp>
 
+using std::atomic;
+using std::condition_variable;
+using std::map;
+using std::mutex;
+using std::pair;
+using std::vector;
 using std::shared_ptr;
 
 namespace pv {
+class Session;
+
 namespace data {
 
-class DecoderStack;
+namespace decode {
+class Annotation;
+class Decoder;
+class Row;
+}
+
 class Logic;
+class LogicSegment;
+class SignalBase;
 class SignalData;
 
+struct DecodeChannel
+{
+       uint16_t id;     ///< Global numerical ID for the decode channels in the stack
+       uint16_t bit_id; ///< Tells which bit within a sample represents this channel
+       const bool is_optional;
+       const pv::data::SignalBase *assigned_signal;
+       const QString name, desc;
+       int initial_pin_state;
+       const shared_ptr<pv::data::decode::Decoder> decoder_;
+       const srd_channel *pdch_;
+};
+
 class DecodeSignal : public SignalBase
 {
        Q_OBJECT
 
+private:
+       static const double DecodeMargin;
+       static const double DecodeThreshold;
+       static const int64_t DecodeChunkLength;
+
 public:
-       DecodeSignal(shared_ptr<pv::data::DecoderStack> decoder_stack);
+       DecodeSignal(pv::Session &session);
        virtual ~DecodeSignal();
 
        bool is_decode_signal() const;
-       shared_ptr<pv::data::DecoderStack> decoder_stack() const;
+       const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;
 
-       void stack_decoder(srd_decoder *decoder);
+       void stack_decoder(const srd_decoder *decoder);
        void remove_decoder(int index);
        bool toggle_decoder_visibility(int index);
 
+       void reset_decode();
+       void begin_decode();
+       QString error_message() const;
+
+       const vector<data::DecodeChannel> get_channels() const;
+       void auto_assign_signals(const shared_ptr<pv::data::decode::Decoder> dec);
+       void assign_signal(const uint16_t channel_id, const SignalBase *signal);
+       int get_assigned_signal_count() const;
+
+       void set_initial_pin_state(const uint16_t channel_id, const int init_state);
+
+       double samplerate() const;
+       const pv::util::Timestamp& start_time() const;
+
+       /**
+        * Returns the number of samples that can be worked on,
+        * i.e. the number of samples where samples are available
+        * for all connected channels.
+        */
+       int64_t get_working_sample_count(uint32_t segment_id) const;
+
+       int64_t get_decoded_sample_count(uint32_t segment_id) const;
+
+       vector<decode::Row> visible_rows() const;
+
+       /**
+        * Extracts sorted annotations between two period into a vector.
+        */
+       void get_annotation_subset(
+               vector<pv::data::decode::Annotation> &dest,
+               const decode::Row &row, uint64_t start_sample,
+               uint64_t end_sample) const;
+
+       virtual void save_settings(QSettings &settings) const;
+
+       virtual void restore_settings(QSettings &settings);
+
+private:
+       void update_channel_list();
+
+       void commit_decoder_channels();
+
+       void mux_logic_samples(const int64_t start, const int64_t end);
+
+       void logic_mux_proc();
+
+       void query_input_metadata();
+
+       void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count);
+
+       void decode_proc();
+
+       void start_srd_session();
+       void stop_srd_session();
+
+       void connect_input_notifiers();
+
+       void create_new_annotation_segment();
+       static void annotation_callback(srd_proto_data *pdata, void *decode_signal);
+
 Q_SIGNALS:
-       void new_annotations();
+       void new_annotations(); // TODO Supply segment for which they belong to
+       void decode_reset();
+       void decode_finished();
+       void channels_updated();
 
 private Q_SLOTS:
-       void on_new_annotations();
+       void on_capture_state_changed(int state);
+       void on_data_cleared();
+       void on_data_received();
 
 private:
-       shared_ptr<pv::data::DecoderStack> decoder_stack_;
+       pv::Session &session_;
+
+       vector<data::DecodeChannel> channels_;
+
+       struct srd_session *srd_session_;
+
+       shared_ptr<Logic> logic_mux_data_;
+       shared_ptr<LogicSegment> logic_mux_segment_;
+       bool logic_mux_data_invalid_;
+
+       pv::util::Timestamp start_time_;
+       double samplerate_;
+
+       int64_t samples_decoded_;
+       uint32_t currently_processed_segment_;
+
+       vector< shared_ptr<decode::Decoder> > stack_;
+       map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
+
+       /// Annotations for all segments
+       vector< map<const decode::Row, decode::RowData>> segmented_rows_;
+
+       /// Set of annotations for current segment
+       map<const decode::Row, decode::RowData> *current_rows_;
+
+       mutable mutex input_mutex_, output_mutex_, logic_mux_mutex_;
+       mutable condition_variable decode_input_cond_, logic_mux_cond_;
+       bool frame_complete_;
+
+       std::thread decode_thread_, logic_mux_thread_;
+       atomic<bool> decode_interrupt_, logic_mux_interrupt_;
+
+       QString error_message_;
 };
 
 } // namespace data