Use nullptr in a few places.
[pulseview.git] / pv / data / decoderstack.cpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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 #include <libsigrokdecode/libsigrokdecode.h>
21
22 #include <stdexcept>
23
24 #include <QDebug>
25
26 #include "decoderstack.hpp"
27
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>
34
35 using std::lock_guard;
36 using std::mutex;
37 using boost::optional;
38 using std::unique_lock;
39 using std::deque;
40 using std::make_pair;
41 using std::max;
42 using std::min;
43 using std::list;
44 using std::map;
45 using std::pair;
46 using std::shared_ptr;
47 using std::vector;
48
49 using namespace pv::data::decode;
50
51 namespace pv {
52 namespace data {
53
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;
58
59 mutex DecoderStack::global_srd_mutex_;
60
61 DecoderStack::DecoderStack(pv::Session &session,
62         const srd_decoder *const dec) :
63         session_(session),
64         start_time_(0),
65         samplerate_(0),
66         sample_count_(0),
67         frame_complete_(false),
68         samples_decoded_(0)
69 {
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()));
76
77         stack_.push_back(shared_ptr<decode::Decoder>(
78                 new decode::Decoder(dec)));
79 }
80
81 DecoderStack::~DecoderStack()
82 {
83         if (decode_thread_.joinable()) {
84                 interrupt_ = true;
85                 input_cond_.notify_one();
86                 decode_thread_.join();
87         }
88 }
89
90 const std::list< std::shared_ptr<decode::Decoder> >&
91 DecoderStack::stack() const
92 {
93         return stack_;
94 }
95
96 void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
97 {
98         assert(decoder);
99         stack_.push_back(decoder);
100 }
101
102 void DecoderStack::remove(int index)
103 {
104         assert(index >= 0);
105         assert(index < (int)stack_.size());
106
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());
111
112         // Delete the element
113         stack_.erase(iter);
114 }
115
116 double DecoderStack::samplerate() const
117 {
118         return samplerate_;
119 }
120
121 const pv::util::Timestamp& DecoderStack::start_time() const
122 {
123         return start_time_;
124 }
125
126 int64_t DecoderStack::samples_decoded() const
127 {
128         lock_guard<mutex> decode_lock(output_mutex_);
129         return samples_decoded_;
130 }
131
132 std::vector<Row> DecoderStack::get_visible_rows() const
133 {
134         lock_guard<mutex> lock(output_mutex_);
135
136         vector<Row> rows;
137
138         for (const shared_ptr<decode::Decoder> &dec : stack_) {
139                 assert(dec);
140                 if (!dec->shown())
141                         continue;
142
143                 const srd_decoder *const decc = dec->decoder();
144                 assert(dec->decoder());
145
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));
149
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;
154                         assert(ann_row);
155                         rows.push_back(Row(decc, ann_row));
156                 }
157         }
158
159         return rows;
160 }
161
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
166 {
167         lock_guard<mutex> lock(output_mutex_);
168
169         const auto iter = rows_.find(row);
170         if (iter != rows_.end())
171                 (*iter).second.get_annotation_subset(dest,
172                         start_sample, end_sample);
173 }
174
175 QString DecoderStack::error_message()
176 {
177         lock_guard<mutex> lock(output_mutex_);
178         return error_message_;
179 }
180
181 void DecoderStack::clear()
182 {
183         sample_count_ = 0;
184         frame_complete_ = false;
185         samples_decoded_ = 0;
186         error_message_ = QString();
187         rows_.clear();
188         class_rows_.clear();
189 }
190
191 void DecoderStack::begin_decode()
192 {
193         if (decode_thread_.joinable()) {
194                 interrupt_ = true;
195                 input_cond_.notify_one();
196                 decode_thread_.join();
197         }
198
199         clear();
200
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");
206                         return;
207                 }
208
209         // Add classes
210         for (const shared_ptr<decode::Decoder> &dec : stack_) {
211                 assert(dec);
212                 const srd_decoder *const decc = dec->decoder();
213                 assert(dec->decoder());
214
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();
218
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;
223                         assert(ann_row);
224
225                         const Row row(decc, ann_row);
226
227                         // Add a new empty row data object
228                         rows_[row] = decode::RowData();
229
230                         // Map out all the classes
231                         for (const GSList *ll = ann_row->ann_classes;
232                                 ll; ll = ll->next)
233                                 class_rows_[make_pair(decc,
234                                         GPOINTER_TO_INT(ll->data))] = row;
235                 }
236         }
237
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;
243
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())))
248                         break;
249
250         if (!data)
251                 return;
252
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())
257                 return;
258         segment_ = segments.front();
259
260         // Get the samplerate and start time
261         start_time_ = segment_->start_time();
262         samplerate_ = segment_->samplerate();
263         if (samplerate_ == 0.0)
264                 samplerate_ = 1.0;
265
266         interrupt_ = false;
267         decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
268 }
269
270 uint64_t DecoderStack::max_sample_count() const
271 {
272         uint64_t max_sample_count = 0;
273
274         for (const auto& row : rows_)
275                 max_sample_count = max(max_sample_count,
276                         row.second.get_max_sample());
277
278         return max_sample_count;
279 }
280
281 optional<int64_t> DecoderStack::wait_for_data() const
282 {
283         unique_lock<mutex> input_lock(input_mutex_);
284
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)) {
290
291                 input_cond_.wait(input_lock);
292         }
293
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))),
300                 sample_count_);
301 }
302
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)
306 {
307         const unsigned int chunk_sample_count =
308                 DecodeChunkLength / segment_->unit_size();
309
310         for (int64_t i = abs_start_samplenum; !interrupt_ && i < sample_count;
311                         i += chunk_sample_count) {
312
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);
316
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");
320                         break;
321                 }
322
323                 {
324                         lock_guard<mutex> lock(output_mutex_);
325                         samples_decoded_ = chunk_end;
326                 }
327
328                 if (i % DecodeNotifyPeriod == 0)
329                         new_decode_data();
330         }
331
332         new_decode_data();
333 }
334
335 void DecoderStack::decode_proc()
336 {
337         optional<int64_t> sample_count;
338         srd_session *session;
339         srd_decoder_inst *prev_di = nullptr;
340
341         assert(segment_);
342
343         // Prevent any other decode threads from accessing libsigrokdecode
344         lock_guard<mutex> srd_lock(global_srd_mutex_);
345
346         // Create the session
347         srd_session_new(&session);
348         assert(session);
349
350         // Create the decoders
351         const unsigned int unit_size = segment_->unit_size();
352
353         for (const shared_ptr<decode::Decoder> &dec : stack_) {
354                 srd_decoder_inst *const di = dec->create_decoder_inst(session);
355
356                 if (!di) {
357                         error_message_ = tr("Failed to create decoder instance");
358                         srd_session_destroy(session);
359                         return;
360                 }
361
362                 if (prev_di)
363                         srd_inst_stack (session, prev_di, di);
364
365                 prev_di = di;
366         }
367
368         // Get the intial sample count
369         {
370                 unique_lock<mutex> input_lock(input_mutex_);
371                 sample_count = sample_count_ = segment_->get_sample_count();
372         }
373
374         // Start the session
375         srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
376                 g_variant_new_uint64((uint64_t)samplerate_));
377
378         srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
379                 DecoderStack::annotation_callback, this);
380
381         srd_session_start(session);
382
383         int64_t abs_start_samplenum = 0;
384         do {
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()));
388
389         // Destroy the session
390         srd_session_destroy(session);
391 }
392
393 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
394 {
395         assert(pdata);
396         assert(decoder);
397
398         DecoderStack *const d = (DecoderStack*)decoder;
399         assert(d);
400
401         lock_guard<mutex> lock(d->output_mutex_);
402
403         const Annotation a(pdata);
404
405         // Find the row
406         assert(pdata->pdo);
407         assert(pdata->pdo->di);
408         const srd_decoder *const decc = pdata->pdo->di->decoder;
409         assert(decc);
410
411         auto row_iter = d->rows_.end();
412
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);
417         else {
418                 // Failing that, use the decoder as a key
419                 row_iter = d->rows_.find(Row(decc));    
420         }
421
422         assert(row_iter != d->rows_.end());
423         if (row_iter == d->rows_.end()) {
424                 qDebug() << "Unexpected annotation: decoder = " << decc <<
425                         ", format = " << a.format();
426                 assert(0);
427                 return;
428         }
429
430         // Add the annotation
431         (*row_iter).second.push_annotation(a);
432 }
433
434 void DecoderStack::on_new_frame()
435 {
436         begin_decode();
437 }
438
439 void DecoderStack::on_data_received()
440 {
441         {
442                 unique_lock<mutex> lock(input_mutex_);
443                 if (segment_)
444                         sample_count_ = segment_->get_sample_count();
445         }
446         input_cond_.notify_one();
447 }
448
449 void DecoderStack::on_frame_ended()
450 {
451         {
452                 unique_lock<mutex> lock(input_mutex_);
453                 if (segment_)
454                         frame_complete_ = true;
455         }
456         input_cond_.notify_one();
457 }
458
459 } // namespace data
460 } // namespace pv