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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <libsigrokdecode/libsigrokdecode.h>
  22
  23 #include <stdexcept>
  24
  25 #include <QDebug>
  26
  27 #include "decoderstack.hpp"
  28
  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>
  35
  36 using std::lock_guard;
  37 using std::mutex;
  38 using boost::optional;
  39 using std::unique_lock;
  40 using std::deque;
  41 using std::make_pair;
  42 using std::max;
  43 using std::min;
  44 using std::list;
  45 using std::map;
  46 using std::pair;
  47 using std::shared_ptr;
  48 using std::vector;
  49
  50 using namespace pv::data::decode;
  51
  52 namespace pv {
  53 namespace data {
  54
  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;
  59
  60 mutex DecoderStack::global_decode_mutex_;
  61
  62 DecoderStack::DecoderStack(pv::Session &session,
  63         const srd_decoder *const dec) :
  64         session_(session),
  65         start_time_(0),
  66         samplerate_(0),
  67         sample_count_(0),
  68         frame_complete_(false),
  69         samples_decoded_(0)
  70 {
  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()));
  77
  78         stack_.push_back(shared_ptr<decode::Decoder>(
  79                 new decode::Decoder(dec)));
  80 }
  81
  82 DecoderStack::~DecoderStack()
  83 {
  84         if (decode_thread_.joinable()) {
  85                 interrupt_ = true;
  86                 input_cond_.notify_one();
  87                 decode_thread_.join();
  88         }
  89 }
  90
  91 const std::list< std::shared_ptr<decode::Decoder> >&
  92 DecoderStack::stack() const
  93 {
  94         return stack_;
  95 }
  96
  97 void DecoderStack::push(std::shared_ptr<decode::Decoder> decoder)
  98 {
  99         assert(decoder);
 100         stack_.push_back(decoder);
 101 }
 102
 103 void DecoderStack::remove(int index)
 104 {
 105         assert(index >= 0);
 106         assert(index < (int)stack_.size());
 107
 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());
 112
 113         // Delete the element
 114         stack_.erase(iter);
 115 }
 116
 117 double DecoderStack::samplerate() const
 118 {
 119         return samplerate_;
 120 }
 121
 122 double DecoderStack::start_time() const
 123 {
 124         return start_time_;
 125 }
 126
 127 int64_t DecoderStack::samples_decoded() const
 128 {
 129         lock_guard<mutex> decode_lock(output_mutex_);
 130         return samples_decoded_;
 131 }
 132
 133 std::vector<Row> DecoderStack::get_visible_rows() const
 134 {
 135         lock_guard<mutex> lock(output_mutex_);
 136
 137         vector<Row> rows;
 138
 139         for (const shared_ptr<decode::Decoder> &dec : stack_)
 140         {
 141                 assert(dec);
 142                 if (!dec->shown())
 143                         continue;
 144
 145                 const srd_decoder *const decc = dec->decoder();
 146                 assert(dec->decoder());
 147
 148                 // Add a row for the decoder if it doesn't have a row list
 149                 if (!decc->annotation_rows)
 150                         rows.push_back(Row(decc));
 151
 152                 // Add the decoder rows
 153                 for (const GSList *l = decc->annotation_rows; l; l = l->next)
 154                 {
 155                         const srd_decoder_annotation_row *const ann_row =
 156                                 (srd_decoder_annotation_row *)l->data;
 157                         assert(ann_row);
 158                         rows.push_back(Row(decc, ann_row));
 159                 }
 160         }
 161
 162         return rows;
 163 }
 164
 165 void DecoderStack::get_annotation_subset(
 166         std::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         frame_complete_ = false;
 188         samples_decoded_ = 0;
 189         error_message_ = QString();
 190         rows_.clear();
 191         class_rows_.clear();
 192 }
 193
 194 void DecoderStack::begin_decode()
 195 {
 196         shared_ptr<pv::view::LogicSignal> logic_signal;
 197         shared_ptr<pv::data::Logic> data;
 198
 199         if (decode_thread_.joinable()) {
 200                 interrupt_ = true;
 201                 input_cond_.notify_one();
 202                 decode_thread_.join();
 203         }
 204
 205         clear();
 206
 207         // Check that all decoders have the required channels
 208         for (const shared_ptr<decode::Decoder> &dec : stack_)
 209                 if (!dec->have_required_channels()) {
 210                         error_message_ = tr("One or more required channels "
 211                                 "have not been specified");
 212                         return;
 213                 }
 214
 215         // Add classes
 216         for (const shared_ptr<decode::Decoder> &dec : stack_)
 217         {
 218                 assert(dec);
 219                 const srd_decoder *const decc = dec->decoder();
 220                 assert(dec->decoder());
 221
 222                 // Add a row for the decoder if it doesn't have a row list
 223                 if (!decc->annotation_rows)
 224                         rows_[Row(decc)] = decode::RowData();
 225
 226                 // Add the decoder rows
 227                 for (const GSList *l = decc->annotation_rows; l; l = l->next)
 228                 {
 229                         const srd_decoder_annotation_row *const ann_row =
 230                                 (srd_decoder_annotation_row *)l->data;
 231                         assert(ann_row);
 232
 233                         const Row row(decc, ann_row);
 234
 235                         // Add a new empty row data object
 236                         rows_[row] = decode::RowData();
 237
 238                         // Map out all the classes
 239                         for (const GSList *ll = ann_row->ann_classes;
 240                                 ll; ll = ll->next)
 241                                 class_rows_[make_pair(decc,
 242                                         GPOINTER_TO_INT(ll->data))] = row;
 243                 }
 244         }
 245
 246         // We get the logic data of the first channel in the list.
 247         // This works because we are currently assuming all
 248         // LogicSignals have the same data/segment
 249         for (const shared_ptr<decode::Decoder> &dec : stack_)
 250                 if (dec && !dec->channels().empty() &&
 251                         ((logic_signal = (*dec->channels().begin()).second)) &&
 252                         ((data = logic_signal->logic_data())))
 253                         break;
 254
 255         if (!data)
 256                 return;
 257
 258         // Check we have a segment of data
 259         const deque< shared_ptr<pv::data::LogicSegment> > &segments =
 260                 data->logic_segments();
 261         if (segments.empty())
 262                 return;
 263         segment_ = segments.front();
 264
 265         // Get the samplerate and start time
 266         start_time_ = segment_->start_time();
 267         samplerate_ = segment_->samplerate();
 268         if (samplerate_ == 0.0)
 269                 samplerate_ = 1.0;
 270
 271         interrupt_ = false;
 272         decode_thread_ = std::thread(&DecoderStack::decode_proc, this);
 273 }
 274
 275 uint64_t DecoderStack::get_max_sample_count() const
 276 {
 277         uint64_t max_sample_count = 0;
 278
 279         for (auto i = rows_.cbegin(); i != rows_.end(); i++)
 280                 max_sample_count = max(max_sample_count,
 281                         (*i).second.get_max_sample());
 282
 283         return max_sample_count;
 284 }
 285
 286 optional<int64_t> DecoderStack::wait_for_data() const
 287 {
 288         unique_lock<mutex> input_lock(input_mutex_);
 289         while(!interrupt_ && !frame_complete_ &&
 290                 samples_decoded_ >= sample_count_)
 291                 input_cond_.wait(input_lock);
 292         return boost::make_optional(!interrupt_ &&
 293                 (samples_decoded_ < sample_count_ || !frame_complete_),
 294                 sample_count_);
 295 }
 296
 297 void DecoderStack::decode_data(
 298         const int64_t sample_count, const unsigned int unit_size,
 299         srd_session *const session)
 300 {
 301         uint8_t chunk[DecodeChunkLength];
 302
 303         const unsigned int chunk_sample_count =
 304                 DecodeChunkLength / segment_->unit_size();
 305
 306         for (int64_t i = 0; !interrupt_ && i < sample_count;
 307                 i += chunk_sample_count)
 308         {
 309                 lock_guard<mutex> decode_lock(global_decode_mutex_);
 310
 311                 const int64_t chunk_end = min(
 312                         i + chunk_sample_count, sample_count);
 313                 segment_->get_samples(chunk, i, chunk_end);
 314
 315                 if (srd_session_send(session, i, i + sample_count, chunk,
 316                                 (chunk_end - i) * unit_size) != SRD_OK) {
 317                         error_message_ = tr("Decoder reported an error");
 318                         break;
 319                 }
 320
 321                 {
 322                         lock_guard<mutex> lock(output_mutex_);
 323                         samples_decoded_ = chunk_end;
 324                 }
 325
 326                 if (i % DecodeNotifyPeriod == 0)
 327                         new_decode_data();
 328         }
 329
 330         new_decode_data();
 331 }
 332
 333 void DecoderStack::decode_proc()
 334 {
 335         optional<int64_t> sample_count;
 336         srd_session *session;
 337         srd_decoder_inst *prev_di = NULL;
 338
 339         assert(segment_);
 340
 341         // Create the session
 342         srd_session_new(&session);
 343         assert(session);
 344
 345         // Create the decoders
 346         const unsigned int unit_size = segment_->unit_size();
 347
 348         for (const shared_ptr<decode::Decoder> &dec : stack_)
 349         {
 350                 srd_decoder_inst *const di = dec->create_decoder_inst(session, unit_size);
 351
 352                 if (!di)
 353                 {
 354                         error_message_ = tr("Failed to create decoder instance");
 355                         srd_session_destroy(session);
 356                         return;
 357                 }
 358
 359                 if (prev_di)
 360                         srd_inst_stack (session, prev_di, di);
 361
 362                 prev_di = di;
 363         }
 364
 365         // Get the intial sample count
 366         {
 367                 unique_lock<mutex> input_lock(input_mutex_);
 368                 sample_count = sample_count_ = segment_->get_sample_count();
 369         }
 370
 371         // Start the session
 372         srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
 373                 g_variant_new_uint64((uint64_t)samplerate_));
 374
 375         srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
 376                 DecoderStack::annotation_callback, this);
 377
 378         srd_session_start(session);
 379
 380         do {
 381                 decode_data(*sample_count, unit_size, session);
 382         } while(error_message_.isEmpty() && (sample_count = wait_for_data()));
 383
 384         // Destroy the session
 385         srd_session_destroy(session);
 386 }
 387
 388 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
 389 {
 390         assert(pdata);
 391         assert(decoder);
 392
 393         DecoderStack *const d = (DecoderStack*)decoder;
 394         assert(d);
 395
 396         lock_guard<mutex> lock(d->output_mutex_);
 397
 398         const Annotation a(pdata);
 399
 400         // Find the row
 401         assert(pdata->pdo);
 402         assert(pdata->pdo->di);
 403         const srd_decoder *const decc = pdata->pdo->di->decoder;
 404         assert(decc);
 405
 406         auto row_iter = d->rows_.end();
 407
 408         // Try looking up the sub-row of this class
 409         const auto r = d->class_rows_.find(make_pair(decc, a.format()));
 410         if (r != d->class_rows_.end())
 411                 row_iter = d->rows_.find((*r).second);
 412         else
 413         {
 414                 // Failing that, use the decoder as a key
 415                 row_iter = d->rows_.find(Row(decc));
 416         }
 417
 418         assert(row_iter != d->rows_.end());
 419         if (row_iter == d->rows_.end()) {
 420                 qDebug() << "Unexpected annotation: decoder = " << decc <<
 421                         ", format = " << a.format();
 422                 assert(0);
 423                 return;
 424         }
 425
 426         // Add the annotation
 427         (*row_iter).second.push_annotation(a);
 428 }
 429
 430 void DecoderStack::on_new_frame()
 431 {
 432         begin_decode();
 433 }
 434
 435 void DecoderStack::on_data_received()
 436 {
 437         {
 438                 unique_lock<mutex> lock(input_mutex_);
 439                 if (segment_)
 440                         sample_count_ = segment_->get_sample_count();
 441         }
 442         input_cond_.notify_one();
 443 }
 444
 445 void DecoderStack::on_frame_ended()
 446 {
 447         {
 448                 unique_lock<mutex> lock(input_mutex_);
 449                 if (segment_)
 450                         frame_complete_ = true;
 451         }
 452         input_cond_.notify_one();
 453 }
 454
 455 } // namespace data
 456 } // namespace pv