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.h"
  28
  29 #include <pv/data/logic.h>
  30 #include <pv/data/logicsnapshot.h>
  31 #include <pv/data/decode/decoder.h>
  32 #include <pv/data/decode/annotation.h>
  33 #include <pv/sigsession.h>
  34 #include <pv/view/logicsignal.h>
  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::SigSession &session,
  63         const srd_decoder *const dec) :
  64         _session(session),
  65         _sample_count(0),
  66         _frame_complete(false),
  67         _samples_decoded(0)
  68 {
  69         connect(&_session, SIGNAL(frame_began()),
  70                 this, SLOT(on_new_frame()));
  71         connect(&_session, SIGNAL(data_received()),
  72                 this, SLOT(on_data_received()));
  73         connect(&_session, SIGNAL(frame_ended()),
  74                 this, SLOT(on_frame_ended()));
  75
  76         _stack.push_back(shared_ptr<decode::Decoder>(
  77                 new decode::Decoder(dec)));
  78 }
  79
  80 DecoderStack::~DecoderStack()
  81 {
  82         if (_decode_thread.joinable()) {
  83                 _interrupt = true;
  84                 _decode_thread.join();
  85         }
  86 }
  87
  88 const std::list< std::shared_ptr<decode::Decoder> >&
  89 DecoderStack::stack() const
  90 {
  91         return _stack;
  92 }
  93
  94 void DecoderStack::push(std::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 int64_t DecoderStack::samples_decoded() const
 115 {
 116         lock_guard<mutex> decode_lock(_output_mutex);
 117         return _samples_decoded;
 118 }
 119
 120 std::vector<Row> DecoderStack::get_visible_rows() const
 121 {
 122         lock_guard<mutex> lock(_output_mutex);
 123
 124         vector<Row> rows;
 125
 126         for (const shared_ptr<decode::Decoder> &dec : _stack)
 127         {
 128                 assert(dec);
 129                 if (!dec->shown())
 130                         continue;
 131
 132                 const srd_decoder *const decc = dec->decoder();
 133                 assert(dec->decoder());
 134
 135                 // Add a row for the decoder if it doesn't have a row list
 136                 if (!decc->annotation_rows)
 137                         rows.push_back(Row(decc));
 138
 139                 // Add the decoder rows
 140                 for (const GSList *l = decc->annotation_rows; l; l = l->next)
 141                 {
 142                         const srd_decoder_annotation_row *const ann_row =
 143                                 (srd_decoder_annotation_row *)l->data;
 144                         assert(ann_row);
 145                         rows.push_back(Row(decc, ann_row));
 146                 }
 147         }
 148
 149         return rows;
 150 }
 151
 152 void DecoderStack::get_annotation_subset(
 153         std::vector<pv::data::decode::Annotation> &dest,
 154         const Row &row, uint64_t start_sample,
 155         uint64_t end_sample) const
 156 {
 157         lock_guard<mutex> lock(_output_mutex);
 158
 159         const auto iter = _rows.find(row);
 160         if (iter != _rows.end())
 161                 (*iter).second.get_annotation_subset(dest,
 162                         start_sample, end_sample);
 163 }
 164
 165 QString DecoderStack::error_message()
 166 {
 167         lock_guard<mutex> lock(_output_mutex);
 168         return _error_message;
 169 }
 170
 171 void DecoderStack::clear()
 172 {
 173         _sample_count = 0;
 174         _frame_complete = false;
 175         _samples_decoded = 0;
 176         _error_message = QString();
 177         _rows.clear();
 178         _class_rows.clear();
 179 }
 180
 181 void DecoderStack::begin_decode()
 182 {
 183         shared_ptr<pv::view::LogicSignal> logic_signal;
 184         shared_ptr<pv::data::Logic> data;
 185
 186         if (_decode_thread.joinable()) {
 187                 _interrupt = true;
 188                 _decode_thread.join();
 189         }
 190
 191         clear();
 192
 193         // Check that all decoders have the required channels
 194         for (const shared_ptr<decode::Decoder> &dec : _stack)
 195                 if (!dec->have_required_probes()) {
 196                         _error_message = tr("One or more required channels "
 197                                 "have not been specified");
 198                         return;
 199                 }
 200
 201         // Add classes
 202         for (const shared_ptr<decode::Decoder> &dec : _stack)
 203         {
 204                 assert(dec);
 205                 const srd_decoder *const decc = dec->decoder();
 206                 assert(dec->decoder());
 207
 208                 // Add a row for the decoder if it doesn't have a row list
 209                 if (!decc->annotation_rows)
 210                         _rows[Row(decc)] = decode::RowData();
 211
 212                 // Add the decoder rows
 213                 for (const GSList *l = decc->annotation_rows; l; l = l->next)
 214                 {
 215                         const srd_decoder_annotation_row *const ann_row =
 216                                 (srd_decoder_annotation_row *)l->data;
 217                         assert(ann_row);
 218
 219                         const Row row(decc, ann_row);
 220
 221                         // Add a new empty row data object
 222                         _rows[row] = decode::RowData();
 223
 224                         // Map out all the classes
 225                         for (const GSList *ll = ann_row->ann_classes;
 226                                 ll; ll = ll->next)
 227                                 _class_rows[make_pair(decc,
 228                                         GPOINTER_TO_INT(ll->data))] = row;
 229                 }
 230         }
 231
 232         // We get the logic data of the first channel in the list.
 233         // This works because we are currently assuming all
 234         // LogicSignals have the same data/snapshot
 235         for (const shared_ptr<decode::Decoder> &dec : _stack)
 236                 if (dec && !dec->channels().empty() &&
 237                         ((logic_signal = (*dec->channels().begin()).second)) &&
 238                         ((data = logic_signal->logic_data())))
 239                         break;
 240
 241         if (!data)
 242                 return;
 243
 244         // Check we have a snapshot of data
 245         const deque< shared_ptr<pv::data::LogicSnapshot> > &snapshots =
 246                 data->get_snapshots();
 247         if (snapshots.empty())
 248                 return;
 249         _snapshot = snapshots.front();
 250
 251         // Get the samplerate and start time
 252         _start_time = data->get_start_time();
 253         _samplerate = data->samplerate();
 254         if (_samplerate == 0.0)
 255                 _samplerate = 1.0;
 256
 257         _interrupt = false;
 258         _decode_thread = std::thread(&DecoderStack::decode_proc, this);
 259 }
 260
 261 uint64_t DecoderStack::get_max_sample_count() const
 262 {
 263         uint64_t max_sample_count = 0;
 264
 265         for (auto i = _rows.cbegin(); i != _rows.end(); i++)
 266                 max_sample_count = max(max_sample_count,
 267                         (*i).second.get_max_sample());
 268
 269         return max_sample_count;
 270 }
 271
 272 optional<int64_t> DecoderStack::wait_for_data() const
 273 {
 274         unique_lock<mutex> input_lock(_input_mutex);
 275         while(!_interrupt && !_frame_complete &&
 276                 _samples_decoded >= _sample_count)
 277                 _input_cond.wait(input_lock);
 278         return boost::make_optional(!_interrupt &&
 279                 (_samples_decoded < _sample_count || !_frame_complete),
 280                 _sample_count);
 281 }
 282
 283 void DecoderStack::decode_data(
 284         const int64_t sample_count, const unsigned int unit_size,
 285         srd_session *const session)
 286 {
 287         uint8_t chunk[DecodeChunkLength];
 288
 289         const unsigned int chunk_sample_count =
 290                 DecodeChunkLength / _snapshot->unit_size();
 291
 292         for (int64_t i = 0; !_interrupt && i < sample_count;
 293                 i += chunk_sample_count)
 294         {
 295                 lock_guard<mutex> decode_lock(_global_decode_mutex);
 296
 297                 const int64_t chunk_end = min(
 298                         i + chunk_sample_count, sample_count);
 299                 _snapshot->get_samples(chunk, i, chunk_end);
 300
 301                 if (srd_session_send(session, i, i + sample_count, chunk,
 302                                 (chunk_end - i) * unit_size) != SRD_OK) {
 303                         _error_message = tr("Decoder reported an error");
 304                         break;
 305                 }
 306
 307                 {
 308                         lock_guard<mutex> lock(_output_mutex);
 309                         _samples_decoded = chunk_end;
 310                 }
 311
 312                 if (i % DecodeNotifyPeriod == 0)
 313                         new_decode_data();
 314         }
 315
 316         new_decode_data();
 317 }
 318
 319 void DecoderStack::decode_proc()
 320 {
 321         optional<int64_t> sample_count;
 322         srd_session *session;
 323         srd_decoder_inst *prev_di = NULL;
 324
 325         assert(_snapshot);
 326
 327         // Create the session
 328         srd_session_new(&session);
 329         assert(session);
 330
 331         // Create the decoders
 332         const unsigned int unit_size = _snapshot->unit_size();
 333
 334         for (const shared_ptr<decode::Decoder> &dec : _stack)
 335         {
 336                 srd_decoder_inst *const di = dec->create_decoder_inst(session, unit_size);
 337
 338                 if (!di)
 339                 {
 340                         _error_message = tr("Failed to create decoder instance");
 341                         srd_session_destroy(session);
 342                         return;
 343                 }
 344
 345                 if (prev_di)
 346                         srd_inst_stack (session, prev_di, di);
 347
 348                 prev_di = di;
 349         }
 350
 351         // Get the intial sample count
 352         {
 353                 unique_lock<mutex> input_lock(_input_mutex);
 354                 sample_count = _sample_count = _snapshot->get_sample_count();
 355         }
 356
 357         // Start the session
 358         srd_session_metadata_set(session, SRD_CONF_SAMPLERATE,
 359                 g_variant_new_uint64((uint64_t)_samplerate));
 360
 361         srd_pd_output_callback_add(session, SRD_OUTPUT_ANN,
 362                 DecoderStack::annotation_callback, this);
 363
 364         srd_session_start(session);
 365
 366         do {
 367                 decode_data(*sample_count, unit_size, session);
 368         } while(_error_message.isEmpty() && (sample_count = wait_for_data()));
 369
 370         // Destroy the session
 371         srd_session_destroy(session);
 372 }
 373
 374 void DecoderStack::annotation_callback(srd_proto_data *pdata, void *decoder)
 375 {
 376         assert(pdata);
 377         assert(decoder);
 378
 379         DecoderStack *const d = (DecoderStack*)decoder;
 380         assert(d);
 381
 382         lock_guard<mutex> lock(d->_output_mutex);
 383
 384         const Annotation a(pdata);
 385
 386         // Find the row
 387         assert(pdata->pdo);
 388         assert(pdata->pdo->di);
 389         const srd_decoder *const decc = pdata->pdo->di->decoder;
 390         assert(decc);
 391
 392         auto row_iter = d->_rows.end();
 393
 394         // Try looking up the sub-row of this class
 395         const auto r = d->_class_rows.find(make_pair(decc, a.format()));
 396         if (r != d->_class_rows.end())
 397                 row_iter = d->_rows.find((*r).second);
 398         else
 399         {
 400                 // Failing that, use the decoder as a key
 401                 row_iter = d->_rows.find(Row(decc));
 402         }
 403
 404         assert(row_iter != d->_rows.end());
 405         if (row_iter == d->_rows.end()) {
 406                 qDebug() << "Unexpected annotation: decoder = " << decc <<
 407                         ", format = " << a.format();
 408                 assert(0);
 409                 return;
 410         }
 411
 412         // Add the annotation
 413         (*row_iter).second.push_annotation(a);
 414 }
 415
 416 void DecoderStack::on_new_frame()
 417 {
 418         begin_decode();
 419 }
 420
 421 void DecoderStack::on_data_received()
 422 {
 423         {
 424                 unique_lock<mutex> lock(_input_mutex);
 425                 if (_snapshot)
 426                         _sample_count = _snapshot->get_sample_count();
 427         }
 428         _input_cond.notify_one();
 429 }
 430
 431 void DecoderStack::on_frame_ended()
 432 {
 433         {
 434                 unique_lock<mutex> lock(_input_mutex);
 435                 if (_snapshot)
 436                         _frame_complete = true;
 437         }
 438         _input_cond.notify_one();
 439 }
 440
 441 } // namespace data
 442 } // namespace pv