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/decode/annotation.hpp>
  29 #include <pv/data/decode/decoder.hpp>
  30 #include <pv/data/logic.hpp>
  31 #include <pv/data/logicsegment.hpp>
  32 #include <pv/session.hpp>
  33 #include <pv/views/trace/logicsignal.hpp>
  34
  35 using std::lock_guard;
  36 using std::mutex;
  37 using std::unique_lock;
  38 using std::deque;
  39 using std::make_pair;
  40 using std::max;
  41 using std::min;
  42 using std::list;
  43 using std::shared_ptr;
  44 using std::make_shared;
  45 using std::vector;
  46
  47 using boost::optional;
  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(make_shared<decode::Decoder>(dec));
  78 }
  79
  80 DecoderStack::~DecoderStack()
  81 {
  82         if (decode_thread_.joinable()) {
  83                 interrupt_ = true;
  84                 input_cond_.notify_one();
  85                 decode_thread_.join();
  86         }
  87 }
  88
  89 const list< shared_ptr<decode::Decoder> >& DecoderStack::stack() const
  90 {
  91         return stack_;
  92 }
  93
  94 void DecoderStack::push(shared_ptr<decode::Decoder> decoder)
  95 {
  96         assert(decoder);
  97         stack_.push_back(decoder);
  98 }
  99
 100 void DecoderStack::remove(int index)
 101 {
 102         assert(index >= 0);
 103         assert(index < (int)stack_.size());
 104
 105         // Find the decoder in the stack
 106         auto iter = stack_.begin();
 107         for (int i = 0; i < index; i++, iter++)
 108                 assert(iter != stack_.end());
 109
 110         // Delete the element
 111         stack_.erase(iter);
 112 }
 113
 114 double DecoderStack::samplerate() const
 115 {
 116         return samplerate_;
 117 }
 118
 119 const pv::util::Timestamp& DecoderStack::start_time() const
 120 {
 121         return start_time_;
 122 }
 123
 124 int64_t DecoderStack::samples_decoded() const
 125 {
 126         lock_guard<mutex> decode_lock(output_mutex_);
 127         return samples_decoded_;
 128 }
 129
 130 vector<Row> DecoderStack::get_visible_rows() const
 131 {
 132         lock_guard<mutex> lock(output_mutex_);
 133
 134         vector<Row> rows;
 135
 136         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 137                 assert(dec);
 138                 if (!dec->shown())
 139                         continue;
 140
 141                 const srd_decoder *const decc = dec->decoder();
 142                 assert(dec->decoder());
 143
 144                 // Add a row for the decoder if it doesn't have a row list
 145                 if (!decc->annotation_rows)
 146                         rows.emplace_back(decc);
 147
 148                 // Add the decoder rows
 149                 for (const GSList *l = decc->annotation_rows; l; l = l->next) {
 150                         const srd_decoder_annotation_row *const ann_row =
 151                                 (srd_decoder_annotation_row *)l->data;
 152                         assert(ann_row);
 153                         rows.emplace_back(decc, ann_row);
 154                 }
 155         }
 156
 157         return rows;
 158 }
 159
 160 uint64_t DecoderStack::inc_annotation_count()
 161 {
 162         return (annotation_count_++);
 163 }
 164
 165 void DecoderStack::get_annotation_subset(
 166         vector<pv::data::decode::Annotation> &dest,
 167         const Row &row, uint64_t start_sample,
 168         uint64_t end_sample) const
 169 {
 170         lock_guard<mutex> lock(output_mutex_);
 171
 172         const auto iter = rows_.find(row);
 173         if (iter != rows_.end())
 174                 (*iter).second.get_annotation_subset(dest,
 175                         start_sample, end_sample);
 176 }
 177
 178 QString DecoderStack::error_message()
 179 {
 180         lock_guard<mutex> lock(output_mutex_);
 181         return error_message_;
 182 }
 183
 184 void DecoderStack::clear()
 185 {
 186         sample_count_ = 0;
 187         annotation_count_ = 0;
 188         frame_complete_ = false;
 189         samples_decoded_ = 0;
 190         error_message_ = QString();
 191         rows_.clear();
 192         class_rows_.clear();
 193 }
 194
 195 void DecoderStack::begin_decode()
 196 {
 197         if (decode_thread_.joinable()) {
 198                 interrupt_ = true;
 199                 input_cond_.notify_one();
 200                 decode_thread_.join();
 201         }
 202
 203         clear();
 204
 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");
 210                         return;
 211                 }
 212
 213         // Add classes
 214         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 215                 assert(dec);
 216                 const srd_decoder *const decc = dec->decoder();
 217                 assert(dec->decoder());
 218
 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();
 222
 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;
 227                         assert(ann_row);
 228
 229                         const Row row(decc, ann_row);
 230
 231                         // Add a new empty row data object
 232                         rows_[row] = decode::RowData();
 233
 234                         // Map out all the classes
 235                         for (const GSList *ll = ann_row->ann_classes;
 236                                 ll; ll = ll->next)
 237                                 class_rows_[make_pair(decc,
 238                                         GPOINTER_TO_INT(ll->data))] = row;
 239                 }
 240         }
 241
 242         // We get the logic data of the first channel in the list.
 243         // This works because we are currently assuming all
 244         // logic signals have the same data/segment
 245         pv::data::SignalBase *signalbase;
 246         pv::data::Logic *data = nullptr;
 247
 248         for (const shared_ptr<decode::Decoder> &dec : stack_)
 249                 if (dec && !dec->channels().empty() &&
 250                         ((signalbase = (*dec->channels().begin()).second.get())) &&
 251                         ((data = signalbase->logic_data().get())))
 252                         break;
 253
 254         if (!data)
 255                 return;
 256
 257         // Check we have a segment of data
 258         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 259                 data->logic_segments();
 260         if (segments.empty())
 261                 return;
 262         segment_ = segments.front();
 263
 264         // Get the samplerate and start time
 265         start_time_ = segment_->start_time();
 266         samplerate_ = segment_->samplerate();
 267         if (samplerate_ == 0.0)
 268                 samplerate_ = 1.0;
 269
 270         interrupt_ = false;
 271         decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
 272 }
 273
 274 uint64_t DecoderStack::max_sample_count() const
 275 {
 276         uint64_t max_sample_count = 0;
 277
 278         for (const auto& row : rows_)
 279                 max_sample_count = max(max_sample_count,
 280                         row.second.get_max_sample());
 281
 282         return max_sample_count;
 283 }
 284
 285 optional<int64_t> DecoderStack::wait_for_data() const
 286 {
 287         unique_lock<mutex> input_lock(input_mutex_);
 288
 289         // Do wait if we decoded all samples but we're still capturing
 290         // Do not wait if we're done capturing
 291         while (!interrupt_ && !frame_complete_ &&
 292                 (samples_decoded_ >= sample_count_) &&
 293                 (session_.get_capture_state() != Session::Stopped)) {
 294
 295                 input_cond_.wait(input_lock);
 296         }
 297
 298         // Return value is valid if we're not aborting the decode,
 299         return boost::make_optional(!interrupt_ &&
 300                 // and there's more work to do...
 301                 (samples_decoded_ < sample_count_ || !frame_complete_) &&
 302                 // and if the end of the data hasn't been reached yet
 303                 (!((samples_decoded_ >= sample_count_) && (session_.get_capture_state() == Session::Stopped))),
 304                 sample_count_);
 305 }
 306
 307 void DecoderStack::decode_data(
 308         const int64_t abs_start_samplenum, const int64_t sample_count, const unsigned int unit_size,
 309         srd_session *const session)
 310 {
 311         const unsigned int chunk_sample_count =
 312                 DecodeChunkLength / segment_->unit_size();
 313
 314         for (int64_t i = abs_start_samplenum; !interrupt_ && i < sample_count;
 315                         i += chunk_sample_count) {
 316
 317                 const int64_t chunk_end = min(
 318                         i + chunk_sample_count, sample_count);
 319                 const uint8_t* chunk = segment_->get_samples(i, chunk_end);
 320
 321                 if (srd_session_send(session, i, chunk_end, chunk,
 322                                 (chunk_end - i) * unit_size, unit_size) != SRD_OK) {
 323                         error_message_ = tr("Decoder reported an error");
 324                         delete[] chunk;
 325                         break;
 326                 }
 327                 delete[] chunk;
 328
 329                 {
 330                         lock_guard<mutex> lock(output_mutex_);
 331                         samples_decoded_ = chunk_end;
 332                 }
 333         }
 334 }
 335
 336 void DecoderStack::decode_proc()
 337 {
 338         optional<int64_t> sample_count;
 339         srd_session *session;
 340         srd_decoder_inst *prev_di = nullptr;
 341
 342         assert(segment_);
 343
 344         // Prevent any other decode threads from accessing libsigrokdecode
 345         lock_guard<mutex> srd_lock(global_srd_mutex_);
 346
 347         // Create the session
 348         srd_session_new(&session);
 349         assert(session);
 350
 351         // Create the decoders
 352         const unsigned int unit_size = segment_->unit_size();
 353
 354         for (const shared_ptr<decode::Decoder> &dec : stack_) {
 355                 srd_decoder_inst *const di = dec->create_decoder_inst(session);
 356
 357                 if (!di) {
 358                         error_message_ = tr("Failed to create decoder instance");
 359                         srd_session_destroy(session);
 360                         return;
 361                 }
 362
 363                 if (prev_di)
 364                         srd_inst_stack (session, prev_di, di);
 365
 366                 prev_di = di;
 367         }
 368
 369         // Get the intial sample count
 370         {
 371                 unique_lock<mutex> input_lock(input_mutex_);
 372                 sample_count = sample_count_ = segment_->get_sample_count();
 373         }
 374
 375         // Start the session
 376         srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
 377                 g_variant_new_uint64((uint64_t)samplerate_));
 378
 379         srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
 380                 DecoderStack::annotation_callback, this);
 381
 382         srd_session_start(session);
 383
 384         int64_t abs_start_samplenum = 0;
 385         do {
 386                 decode_data(abs_start_samplenum, *sample_count, unit_size, session);
 387                 abs_start_samplenum = *sample_count;
 388         } while (error_message_.isEmpty() && (sample_count = wait_for_data()));
 389
 390         // Make sure all annotations are known to the frontend
 391         new_annotations();
 392
 393         // Destroy the session
 394         srd_session_destroy(session);
 395 }
 396
 397 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder_stack)
 398 {
 399         assert(pdata);
 400         assert(decoder);
 401
 402         DecoderStack *const ds = (DecoderStack*)decoder_stack;
 403         assert(ds);
 404
 405         lock_guard<mutex> lock(ds->output_mutex_);
 406
 407         const Annotation a(pdata);
 408
 409         // Find the row
 410         assert(pdata->pdo);
 411         assert(pdata->pdo->di);
 412         const srd_decoder *const decc = pdata->pdo->di->decoder;
 413         assert(decc);
 414
 415         auto row_iter = ds->rows_.end();
 416
 417         // Try looking up the sub-row of this class
 418         const auto r = ds->class_rows_.find(make_pair(decc, a.format()));
 419         if (r != ds->class_rows_.end())
 420                 row_iter = ds->rows_.find((*r).second);
 421         else {
 422                 // Failing that, use the decoder as a key
 423                 row_iter = ds->rows_.find(Row(decc));
 424         }
 425
 426         assert(row_iter != ds->rows_.end());
 427         if (row_iter == ds->rows_.end()) {
 428                 qDebug() << "Unexpected annotation: decoder = " << decc <<
 429                         ", format = " << a.format();
 430                 assert(false);
 431                 return;
 432         }
 433
 434         // Add the annotation
 435         (*row_iter).second.push_annotation(a);
 436
 437         // Notify the frontend every DecodeNotifyPeriod annotations
 438         if (ds->inc_annotation_count() % DecodeNotifyPeriod == 0)
 439                 ds->new_annotations();
 440 }
 441
 442 void DecoderStack::on_new_frame()
 443 {
 444         begin_decode();
 445 }
 446
 447 void DecoderStack::on_data_received()
 448 {
 449         {
 450                 unique_lock<mutex> lock(input_mutex_);
 451                 if (segment_)
 452                         sample_count_ = segment_->get_sample_count();
 453         }
 454         input_cond_.notify_one();
 455 }
 456
 457 void DecoderStack::on_frame_ended()
 458 {
 459         {
 460                 unique_lock<mutex> lock(input_mutex_);
 461                 if (segment_)
 462                         frame_complete_ = true;
 463         }
 464         input_cond_.notify_one();
 465 }
 466
 467 } // namespace data
 468 } // namespace pv