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