]> sigrok.org Git - pulseview.git/blobdiff - pv/data/decodesignal.hpp
DecodeSignal: Add and use inclusive/exclusive sample count variant
[pulseview.git] / pv / data / decodesignal.hpp
index 2d4d4e0c768a8a959e6bf25e3a0e97a7ad8603c0..9bbdd2c4e2c9d68e21d69782f5d2e78ecc0e7000 100644 (file)
@@ -40,7 +40,6 @@ using std::condition_variable;
 using std::map;
 using std::mutex;
 using std::pair;
-using std::unordered_set;
 using std::vector;
 using std::shared_ptr;
 
@@ -62,7 +61,8 @@ class SignalData;
 
 struct DecodeChannel
 {
-       uint16_t id;  // Also tells which bit within a sample represents this channel
+       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;
@@ -71,6 +71,14 @@ struct DecodeChannel
        const srd_channel *pdch_;
 };
 
+struct DecodeSegment
+{
+       map<const decode::Row, decode::RowData> annotation_rows;
+       pv::util::Timestamp start_time;
+       double samplerate;
+       int64_t samples_decoded_incl, samples_decoded_excl;
+};
+
 class DecodeSignal : public SignalBase
 {
        Q_OBJECT
@@ -79,7 +87,6 @@ private:
        static const double DecodeMargin;
        static const double DecodeThreshold;
        static const int64_t DecodeChunkLength;
-       static const unsigned int DecodeNotifyPeriod;
 
 public:
        DecodeSignal(pv::Session &session);
@@ -88,80 +95,97 @@ public:
        bool is_decode_signal() 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 reset_decode(bool shutting_down = false);
        void begin_decode();
        QString error_message() const;
 
        const vector<data::DecodeChannel> get_channels() const;
-       void auto_assign_signals();
+       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;
+       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() const;
+       int64_t get_working_sample_count(uint32_t segment_id) const;
 
-       int64_t get_decoded_sample_count() const;
+       /**
+        * Returns the number of processed samples. Newly generated annotations will
+        * have sample numbers greater than this.
+        *
+        * If include_processing is true, this number will include the ones being
+        * currently processed (in case the decoder stack is running). In this case,
+        * newly generated annotations will have sample numbers smaller than this.
+        */
+       int64_t get_decoded_sample_count(uint32_t segment_id,
+               bool include_processing) const;
 
        vector<decode::Row> visible_rows() const;
 
        /**
-        * Extracts sorted annotations between two period into a vector.
+        * Extracts annotations between the given sample range into a vector.
+        * Note: The annotations are unsorted and only annotations that fully
+        * fit into the sample range are considered.
         */
        void get_annotation_subset(
                vector<pv::data::decode::Annotation> &dest,
-               const decode::Row &row, uint64_t start_sample,
+               const decode::Row &row, uint32_t segment_id, uint64_t start_sample,
                uint64_t end_sample) const;
 
        virtual void save_settings(QSettings &settings) const;
 
        virtual void restore_settings(QSettings &settings);
 
-       /**
-        * Helper function for static annotation_callback(),
-        * must be public so the function can access it.
-        * Don't use from outside this class.
-        */
-       uint64_t inc_annotation_count();
-
 private:
+       void set_error_message(QString msg);
+
+       uint32_t get_input_segment_count() const;
+
+       uint32_t get_input_samplerate(uint32_t segment_id) const;
+
        void update_channel_list();
 
        void commit_decoder_channels();
 
-       void mux_logic_samples(const int64_t start, const int64_t end);
+       void mux_logic_samples(uint32_t segment_id, const int64_t start, const int64_t end);
 
        void logic_mux_proc();
 
-       void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count);
+       void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count,
+               const shared_ptr<LogicSegment> input_segment);
 
        void decode_proc();
 
        void start_srd_session();
+       void terminate_srd_session();
        void stop_srd_session();
 
        void connect_input_notifiers();
 
+       void create_decode_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_capture_state_changed(int state);
+       void on_data_cleared();
        void on_data_received();
 
 private:
@@ -172,29 +196,18 @@ private:
        struct srd_session *srd_session_;
 
        shared_ptr<Logic> logic_mux_data_;
-       shared_ptr<LogicSegment> segment_;
+       uint32_t logic_mux_unit_size_;
        bool logic_mux_data_invalid_;
 
-       pv::util::Timestamp start_time_;
-       double samplerate_;
-
-       int64_t annotation_count_, samples_decoded_;
-
        vector< shared_ptr<decode::Decoder> > stack_;
-       map<const decode::Row, decode::RowData> rows_;
+       bool stack_config_changed_;
        map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
 
-       /**
-        * This mutex prevents more than one thread from accessing
-        * libsigrokdecode concurrently.
-        * @todo A proper solution should be implemented to allow multiple
-        * decode operations in parallel.
-        */
-       static mutex global_srd_mutex_;
+       vector<DecodeSegment> segments_;
+       uint32_t current_segment_id_;
 
        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_;