2 * This file is part of the PulseView project.
4 * Copyright (C) 2017 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
20 #ifndef PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
21 #define PULSEVIEW_PV_DATA_DECODESIGNAL_HPP
24 #include <condition_variable>
25 #include <unordered_set>
31 #include <libsigrokdecode/libsigrokdecode.h>
33 #include <pv/data/decode/row.hpp>
34 #include <pv/data/decode/rowdata.hpp>
35 #include <pv/data/signalbase.hpp>
36 #include <pv/util.hpp>
39 using std::condition_variable;
43 using std::unordered_set;
45 using std::shared_ptr;
65 uint16_t id; // Also tells which bit within a sample represents this channel
66 const bool is_optional;
67 const pv::data::SignalBase *assigned_signal;
68 const QString name, desc;
69 int initial_pin_state;
70 const shared_ptr<pv::data::decode::Decoder> decoder_;
71 const srd_channel *pdch_;
74 class DecodeSignal : public SignalBase
79 static const double DecodeMargin;
80 static const double DecodeThreshold;
81 static const int64_t DecodeChunkLength;
82 static const unsigned int DecodeNotifyPeriod;
85 DecodeSignal(pv::Session &session);
86 virtual ~DecodeSignal();
88 bool is_decode_signal() const;
89 const vector< shared_ptr<data::decode::Decoder> >& decoder_stack() const;
91 void stack_decoder(srd_decoder *decoder);
92 void remove_decoder(int index);
93 bool toggle_decoder_visibility(int index);
97 QString error_message() const;
99 const vector<data::DecodeChannel> get_channels() const;
100 void auto_assign_signals();
101 void assign_signal(const uint16_t channel_id, const SignalBase *signal);
102 int get_assigned_signal_count() const;
104 void set_initial_pin_state(const uint16_t channel_id, const int init_state);
106 double samplerate() const;
107 const pv::util::Timestamp& start_time() const;
110 * Returns the number of samples that can be worked on,
111 * i.e. the number of samples where samples are available
112 * for all connected channels.
114 int64_t get_working_sample_count() const;
116 int64_t get_decoded_sample_count() const;
118 vector<decode::Row> visible_rows() const;
121 * Extracts sorted annotations between two period into a vector.
123 void get_annotation_subset(
124 vector<pv::data::decode::Annotation> &dest,
125 const decode::Row &row, uint64_t start_sample,
126 uint64_t end_sample) const;
128 virtual void save_settings(QSettings &settings) const;
130 virtual void restore_settings(QSettings &settings);
133 * Helper function for static annotation_callback(),
134 * must be public so the function can access it.
135 * Don't use from outside this class.
137 uint64_t inc_annotation_count();
140 void update_channel_list();
142 void commit_decoder_channels();
144 void mux_logic_samples(const int64_t start, const int64_t end);
146 void logic_mux_proc();
148 void decode_data(const int64_t abs_start_samplenum, const int64_t sample_count,
149 srd_session *const session);
153 static void annotation_callback(srd_proto_data *pdata, void *decode_signal);
156 void new_annotations();
157 void channels_updated();
160 void on_capture_state_changed(int state);
161 void on_data_received();
162 void on_frame_ended();
165 pv::Session &session_;
167 vector<data::DecodeChannel> channels_;
169 shared_ptr<Logic> logic_mux_data_;
170 shared_ptr<LogicSegment> segment_;
171 bool logic_mux_data_invalid_;
173 pv::util::Timestamp start_time_;
176 int64_t annotation_count_, samples_decoded_;
178 vector< shared_ptr<decode::Decoder> > stack_;
179 map<const decode::Row, decode::RowData> rows_;
180 map<pair<const srd_decoder*, int>, decode::Row> class_rows_;
183 * This mutex prevents more than one thread from accessing
184 * libsigrokdecode concurrently.
185 * @todo A proper solution should be implemented to allow multiple
186 * decode operations in parallel.
188 static mutex global_srd_mutex_;
190 mutable mutex input_mutex_, output_mutex_, logic_mux_mutex_;
191 mutable condition_variable decode_input_cond_, logic_mux_cond_;
192 bool frame_complete_;
194 std::thread decode_thread_, logic_mux_thread_;
195 atomic<bool> decode_interrupt_, logic_mux_interrupt_;
197 QString error_message_;
203 #endif // PULSEVIEW_PV_DATA_DECODESIGNAL_HPP