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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include <libsigrokdecode/libsigrokdecode.h>
27 #include "decoderstack.hpp"
29 #include <pv/data/logic.hpp>
30 #include <pv/data/logicsegment.hpp>
31 #include <pv/data/decode/decoder.hpp>
32 #include <pv/data/decode/annotation.hpp>
33 #include <pv/session.hpp>
34 #include <pv/view/logicsignal.hpp>
36 using std::lock_guard;
38 using boost::optional;
39 using std::unique_lock;
47 using std::shared_ptr;
50 using namespace pv::data::decode;
55 const double DecoderStack::DecodeMargin = 1.0;
56 const double DecoderStack::DecodeThreshold = 0.2;
57 const int64_t DecoderStack::DecodeChunkLength = 4096;
58 const unsigned int DecoderStack::DecodeNotifyPeriod = 65536;
60 mutex DecoderStack::global_srd_mutex_;
62 DecoderStack::DecoderStack(pv::Session &session,
63 const srd_decoder *const dec) :
68 frame_complete_(false),
71 connect(&session_, SIGNAL(frame_began()),
72 this, SLOT(on_new_frame()));
73 connect(&session_, SIGNAL(data_received()),
74 this, SLOT(on_data_received()));
75 connect(&session_, SIGNAL(frame_ended()),
76 this, SLOT(on_frame_ended()));
78 stack_.push_back(shared_ptr<decode::Decoder>(
79 new decode::Decoder(dec)));
82 DecoderStack::~DecoderStack()
84 if (decode_thread_.joinable()) {
86 input_cond_.notify_one();
87 decode_thread_.join();
91 const std::list< std::shared_ptr<decode::Decoder> >&
92 DecoderStack::stack() const
97 void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
100 stack_.push_back(decoder);
103 void DecoderStack::remove(int index)
106 assert(index < (int)stack_.size());
108 // Find the decoder in the stack
109 auto iter = stack_.begin();
110 for (int i = 0; i < index; i++, iter++)
111 assert(iter != stack_.end());
113 // Delete the element
117 double DecoderStack::samplerate() const
122 const pv::util::Timestamp& DecoderStack::start_time() const
127 int64_t DecoderStack::samples_decoded() const
129 lock_guard<mutex> decode_lock(output_mutex_);
130 return samples_decoded_;
133 std::vector<Row> DecoderStack::get_visible_rows() const
135 lock_guard<mutex> lock(output_mutex_);
139 for (const shared_ptr<decode::Decoder> &dec : stack_) {
144 const srd_decoder *const decc = dec->decoder();
145 assert(dec->decoder());
147 // Add a row for the decoder if it doesn't have a row list
148 if (!decc->annotation_rows)
149 rows.push_back(Row(decc));
151 // Add the decoder rows
152 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
153 const srd_decoder_annotation_row *const ann_row =
154 (srd_decoder_annotation_row *)l->data;
156 rows.push_back(Row(decc, ann_row));
163 void DecoderStack::get_annotation_subset(
164 std::vector<pv::data::decode::Annotation> &dest,
165 const Row &row, uint64_t start_sample,
166 uint64_t end_sample) const
168 lock_guard<mutex> lock(output_mutex_);
170 const auto iter = rows_.find(row);
171 if (iter != rows_.end())
172 (*iter).second.get_annotation_subset(dest,
173 start_sample, end_sample);
176 QString DecoderStack::error_message()
178 lock_guard<mutex> lock(output_mutex_);
179 return error_message_;
182 void DecoderStack::clear()
185 frame_complete_ = false;
186 samples_decoded_ = 0;
187 error_message_ = QString();
192 void DecoderStack::begin_decode()
194 shared_ptr<pv::view::LogicSignal> logic_signal;
195 shared_ptr<pv::data::Logic> data;
197 if (decode_thread_.joinable()) {
199 input_cond_.notify_one();
200 decode_thread_.join();
205 // Check that all decoders have the required channels
206 for (const shared_ptr<decode::Decoder> &dec : stack_)
207 if (!dec->have_required_channels()) {
208 error_message_ = tr("One or more required channels "
209 "have not been specified");
214 for (const shared_ptr<decode::Decoder> &dec : stack_) {
216 const srd_decoder *const decc = dec->decoder();
217 assert(dec->decoder());
219 // Add a row for the decoder if it doesn't have a row list
220 if (!decc->annotation_rows)
221 rows_[Row(decc)] = decode::RowData();
223 // Add the decoder rows
224 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
225 const srd_decoder_annotation_row *const ann_row =
226 (srd_decoder_annotation_row *)l->data;
229 const Row row(decc, ann_row);
231 // Add a new empty row data object
232 rows_[row] = decode::RowData();
234 // Map out all the classes
235 for (const GSList *ll = ann_row->ann_classes;
237 class_rows_[make_pair(decc,
238 GPOINTER_TO_INT(ll->data))] = row;
242 // We get the logic data of the first channel in the list.
243 // This works because we are currently assuming all
244 // LogicSignals have the same data/segment
245 for (const shared_ptr<decode::Decoder> &dec : stack_)
246 if (dec && !dec->channels().empty() &&
247 ((logic_signal = (*dec->channels().begin()).second)) &&
248 ((data = logic_signal->logic_data())))
254 // Check we have a segment of data
255 const deque< shared_ptr<pv::data::LogicSegment> > &segments =
256 data->logic_segments();
257 if (segments.empty())
259 segment_ = segments.front();
261 // Get the samplerate and start time
262 start_time_ = segment_->start_time();
263 samplerate_ = segment_->samplerate();
264 if (samplerate_ == 0.0)
268 decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
271 uint64_t DecoderStack::max_sample_count() const
273 uint64_t max_sample_count = 0;
275 for (const auto& row : rows_)
276 max_sample_count = max(max_sample_count,
277 row.second.get_max_sample());
279 return max_sample_count;
282 optional<int64_t> DecoderStack::wait_for_data() const
284 unique_lock<mutex> input_lock(input_mutex_);
286 // Do wait if we decoded all samples but we're still capturing
287 // Do not wait if we're done capturing
288 while (!interrupt_ && !frame_complete_ &&
289 (samples_decoded_ >= sample_count_) &&
290 (session_.get_capture_state() != Session::Stopped)) {
292 input_cond_.wait(input_lock);
295 // Return value is valid if we're not aborting the decode,
296 return boost::make_optional(!interrupt_ &&
297 // and there's more work to do...
298 (samples_decoded_ < sample_count_ || !frame_complete_) &&
299 // and if the end of the data hasn't been reached yet
300 (!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))),
304 void DecoderStack::decode_data(
305 const int64_t sample_count, const unsigned int unit_size,
306 srd_session *const session)
308 uint8_t chunk[DecodeChunkLength];
310 const unsigned int chunk_sample_count =
311 DecodeChunkLength / segment_->unit_size();
313 for (int64_t i = 0; !interrupt_ && i < sample_count;
314 i += chunk_sample_count) {
316 const int64_t chunk_end = min(
317 i + chunk_sample_count, sample_count);
318 segment_->get_samples(chunk, i, chunk_end);
320 if (srd_session_send(session, i, chunk_end, chunk,
321 (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
322 error_message_ = tr("Decoder reported an error");
327 lock_guard<mutex> lock(output_mutex_);
328 samples_decoded_ = chunk_end;
331 if (i % DecodeNotifyPeriod == 0)
338 void DecoderStack::decode_proc()
340 optional<int64_t> sample_count;
341 srd_session *session;
342 srd_decoder_inst *prev_di = nullptr;
346 // Prevent any other decode threads from accessing libsigrokdecode
347 lock_guard<mutex> srd_lock(global_srd_mutex_);
349 // Create the session
350 srd_session_new(&session);
353 // Create the decoders
354 const unsigned int unit_size = segment_->unit_size();
356 for (const shared_ptr<decode::Decoder> &dec : stack_) {
357 srd_decoder_inst *const di = dec->create_decoder_inst(session);
360 error_message_ = tr("Failed to create decoder instance");
361 srd_session_destroy(session);
366 srd_inst_stack (session, prev_di, di);
371 // Get the intial sample count
373 unique_lock<mutex> input_lock(input_mutex_);
374 sample_count = sample_count_ = segment_->get_sample_count();
378 srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
379 g_variant_new_uint64((uint64_t)samplerate_));
381 srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
382 DecoderStack::annotation_callback, this);
384 srd_session_start(session);
387 decode_data(*sample_count, unit_size, session);
388 } while (error_message_.isEmpty() && (sample_count = wait_for_data()));
390 // Destroy the session
391 srd_session_destroy(session);
394 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
399 DecoderStack *const d = (DecoderStack*)decoder;
402 lock_guard<mutex> lock(d->output_mutex_);
404 const Annotation a(pdata);
408 assert(pdata->pdo->di);
409 const srd_decoder *const decc = pdata->pdo->di->decoder;
412 auto row_iter = d->rows_.end();
414 // Try looking up the sub-row of this class
415 const auto r = d->class_rows_.find(make_pair(decc, a.format()));
416 if (r != d->class_rows_.end())
417 row_iter = d->rows_.find((*r).second);
419 // Failing that, use the decoder as a key
420 row_iter = d->rows_.find(Row(decc));
423 assert(row_iter != d->rows_.end());
424 if (row_iter == d->rows_.end()) {
425 qDebug() << "Unexpected annotation: decoder = " << decc <<
426 ", format = " << a.format();
431 // Add the annotation
432 (*row_iter).second.push_annotation(a);
435 void DecoderStack::on_new_frame()
440 void DecoderStack::on_data_received()
443 unique_lock<mutex> lock(input_mutex_);
445 sample_count_ = segment_->get_sample_count();
447 input_cond_.notify_one();
450 void DecoderStack::on_frame_ended()
453 unique_lock<mutex> lock(input_mutex_);
455 frame_complete_ = true;
457 input_cond_.notify_one();