2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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 #include <libsigrokdecode/libsigrokdecode.h>
26 #include "decoderstack.hpp"
28 #include <pv/data/logic.hpp>
29 #include <pv/data/logicsegment.hpp>
30 #include <pv/data/decode/decoder.hpp>
31 #include <pv/data/decode/annotation.hpp>
32 #include <pv/session.hpp>
33 #include <pv/view/logicsignal.hpp>
35 using std::lock_guard;
37 using boost::optional;
38 using std::unique_lock;
46 using std::shared_ptr;
49 using namespace pv::data::decode;
54 const double DecoderStack::DecodeMargin = 1.0;
55 const double DecoderStack::DecodeThreshold = 0.2;
56 const int64_t DecoderStack::DecodeChunkLength = 10 * 1024 * 1024;
57 const unsigned int DecoderStack::DecodeNotifyPeriod = 1024;
59 mutex DecoderStack::global_srd_mutex_;
61 DecoderStack::DecoderStack(pv::Session &session,
62 const srd_decoder *const dec) :
67 frame_complete_(false),
70 connect(&session_, SIGNAL(frame_began()),
71 this, SLOT(on_new_frame()));
72 connect(&session_, SIGNAL(data_received()),
73 this, SLOT(on_data_received()));
74 connect(&session_, SIGNAL(frame_ended()),
75 this, SLOT(on_frame_ended()));
77 stack_.push_back(shared_ptr<decode::Decoder>(
78 new decode::Decoder(dec)));
81 DecoderStack::~DecoderStack()
83 if (decode_thread_.joinable()) {
85 input_cond_.notify_one();
86 decode_thread_.join();
90 const std::list< std::shared_ptr<decode::Decoder> >&
91 DecoderStack::stack() const
96 void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
99 stack_.push_back(decoder);
102 void DecoderStack::remove(int index)
105 assert(index < (int)stack_.size());
107 // Find the decoder in the stack
108 auto iter = stack_.begin();
109 for (int i = 0; i < index; i++, iter++)
110 assert(iter != stack_.end());
112 // Delete the element
116 double DecoderStack::samplerate() const
121 const pv::util::Timestamp& DecoderStack::start_time() const
126 int64_t DecoderStack::samples_decoded() const
128 lock_guard<mutex> decode_lock(output_mutex_);
129 return samples_decoded_;
132 std::vector<Row> DecoderStack::get_visible_rows() const
134 lock_guard<mutex> lock(output_mutex_);
138 for (const shared_ptr<decode::Decoder> &dec : stack_) {
143 const srd_decoder *const decc = dec->decoder();
144 assert(dec->decoder());
146 // Add a row for the decoder if it doesn't have a row list
147 if (!decc->annotation_rows)
148 rows.push_back(Row(decc));
150 // Add the decoder rows
151 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
152 const srd_decoder_annotation_row *const ann_row =
153 (srd_decoder_annotation_row *)l->data;
155 rows.push_back(Row(decc, ann_row));
162 void DecoderStack::get_annotation_subset(
163 std::vector<pv::data::decode::Annotation> &dest,
164 const Row &row, uint64_t start_sample,
165 uint64_t end_sample) const
167 lock_guard<mutex> lock(output_mutex_);
169 const auto iter = rows_.find(row);
170 if (iter != rows_.end())
171 (*iter).second.get_annotation_subset(dest,
172 start_sample, end_sample);
175 QString DecoderStack::error_message()
177 lock_guard<mutex> lock(output_mutex_);
178 return error_message_;
181 void DecoderStack::clear()
184 frame_complete_ = false;
185 samples_decoded_ = 0;
186 error_message_ = QString();
191 void DecoderStack::begin_decode()
193 if (decode_thread_.joinable()) {
195 input_cond_.notify_one();
196 decode_thread_.join();
201 // Check that all decoders have the required channels
202 for (const shared_ptr<decode::Decoder> &dec : stack_)
203 if (!dec->have_required_channels()) {
204 error_message_ = tr("One or more required channels "
205 "have not been specified");
210 for (const shared_ptr<decode::Decoder> &dec : stack_) {
212 const srd_decoder *const decc = dec->decoder();
213 assert(dec->decoder());
215 // Add a row for the decoder if it doesn't have a row list
216 if (!decc->annotation_rows)
217 rows_[Row(decc)] = decode::RowData();
219 // Add the decoder rows
220 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
221 const srd_decoder_annotation_row *const ann_row =
222 (srd_decoder_annotation_row *)l->data;
225 const Row row(decc, ann_row);
227 // Add a new empty row data object
228 rows_[row] = decode::RowData();
230 // Map out all the classes
231 for (const GSList *ll = ann_row->ann_classes;
233 class_rows_[make_pair(decc,
234 GPOINTER_TO_INT(ll->data))] = row;
238 // We get the logic data of the first channel in the list.
239 // This works because we are currently assuming all
240 // logic signals have the same data/segment
241 pv::data::SignalBase *signalbase;
242 pv::data::Logic *data = nullptr;
244 for (const shared_ptr<decode::Decoder> &dec : stack_)
245 if (dec && !dec->channels().empty() &&
246 ((signalbase = (*dec->channels().begin()).second.get())) &&
247 ((data = signalbase->logic_data().get())))
253 // Check we have a segment of data
254 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
255 data->logic_segments();
256 if (segments.empty())
258 segment_ = segments.front();
260 // Get the samplerate and start time
261 start_time_ = segment_->start_time();
262 samplerate_ = segment_->samplerate();
263 if (samplerate_ == 0.0)
267 decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
270 uint64_t DecoderStack::max_sample_count() const
272 uint64_t max_sample_count = 0;
274 for (const auto& row : rows_)
275 max_sample_count = max(max_sample_count,
276 row.second.get_max_sample());
278 return max_sample_count;
281 optional<int64_t> DecoderStack::wait_for_data() const
283 unique_lock<mutex> input_lock(input_mutex_);
285 // Do wait if we decoded all samples but we're still capturing
286 // Do not wait if we're done capturing
287 while (!interrupt_ && !frame_complete_ &&
288 (samples_decoded_ >= sample_count_) &&
289 (session_.get_capture_state() != Session::Stopped)) {
291 input_cond_.wait(input_lock);
294 // Return value is valid if we're not aborting the decode,
295 return boost::make_optional(!interrupt_ &&
296 // and there's more work to do...
297 (samples_decoded_ < sample_count_ || !frame_complete_) &&
298 // and if the end of the data hasn't been reached yet
299 (!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))),
303 void DecoderStack::decode_data(
304 const int64_t abs_start_samplenum, const int64_t sample_count, const unsigned int unit_size,
305 srd_session *const session)
307 const unsigned int chunk_sample_count =
308 DecodeChunkLength / segment_->unit_size();
310 for (int64_t i = abs_start_samplenum; !interrupt_ && i < sample_count;
311 i += chunk_sample_count) {
313 const int64_t chunk_end = min(
314 i + chunk_sample_count, sample_count);
315 const uint8_t* chunk = segment_->get_samples(i, chunk_end);
317 if (srd_session_send(session, i, chunk_end, chunk,
318 (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
319 error_message_ = tr("Decoder reported an error");
324 lock_guard<mutex> lock(output_mutex_);
325 samples_decoded_ = chunk_end;
328 if (i % DecodeNotifyPeriod == 0)
335 void DecoderStack::decode_proc()
337 optional<int64_t> sample_count;
338 srd_session *session;
339 srd_decoder_inst *prev_di = nullptr;
343 // Prevent any other decode threads from accessing libsigrokdecode
344 lock_guard<mutex> srd_lock(global_srd_mutex_);
346 // Create the session
347 srd_session_new(&session);
350 // Create the decoders
351 const unsigned int unit_size = segment_->unit_size();
353 for (const shared_ptr<decode::Decoder> &dec : stack_) {
354 srd_decoder_inst *const di = dec->create_decoder_inst(session);
357 error_message_ = tr("Failed to create decoder instance");
358 srd_session_destroy(session);
363 srd_inst_stack (session, prev_di, di);
368 // Get the intial sample count
370 unique_lock<mutex> input_lock(input_mutex_);
371 sample_count = sample_count_ = segment_->get_sample_count();
375 srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
376 g_variant_new_uint64((uint64_t)samplerate_));
378 srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
379 DecoderStack::annotation_callback, this);
381 srd_session_start(session);
383 int64_t abs_start_samplenum = 0;
385 decode_data(abs_start_samplenum, *sample_count, unit_size, session);
386 abs_start_samplenum = *sample_count;
387 } while (error_message_.isEmpty() && (sample_count = wait_for_data()));
389 // Destroy the session
390 srd_session_destroy(session);
393 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
398 DecoderStack *const d = (DecoderStack*)decoder;
401 lock_guard<mutex> lock(d->output_mutex_);
403 const Annotation a(pdata);
407 assert(pdata->pdo->di);
408 const srd_decoder *const decc = pdata->pdo->di->decoder;
411 auto row_iter = d->rows_.end();
413 // Try looking up the sub-row of this class
414 const auto r = d->class_rows_.find(make_pair(decc, a.format()));
415 if (r != d->class_rows_.end())
416 row_iter = d->rows_.find((*r).second);
418 // Failing that, use the decoder as a key
419 row_iter = d->rows_.find(Row(decc));
422 assert(row_iter != d->rows_.end());
423 if (row_iter == d->rows_.end()) {
424 qDebug() << "Unexpected annotation: decoder = " << decc <<
425 ", format = " << a.format();
430 // Add the annotation
431 (*row_iter).second.push_annotation(a);
434 void DecoderStack::on_new_frame()
439 void DecoderStack::on_data_received()
442 unique_lock<mutex> lock(input_mutex_);
444 sample_count_ = segment_->get_sample_count();
446 input_cond_.notify_one();
449 void DecoderStack::on_frame_ended()
452 unique_lock<mutex> lock(input_mutex_);
454 frame_complete_ = true;
456 input_cond_.notify_one();