pv/data/signalbase.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include "analog.hpp"
  22 #include "analogsegment.hpp"
  23 #include "decode/row.hpp"
  24 #include "logic.hpp"
  25 #include "logicsegment.hpp"
  26 #include "signalbase.hpp"
  27 #include "signaldata.hpp"
  28
  29 #include <QDebug>
  30
  31 #include <pv/binding/decoder.hpp>
  32 #include <pv/session.hpp>
  33
  34 using std::dynamic_pointer_cast;
  35 using std::make_shared;
  36 using std::out_of_range;
  37 using std::shared_ptr;
  38 using std::tie;
  39 using std::unique_lock;
  40
  41 namespace pv {
  42 namespace data {
  43
  44 const int SignalBase::ColourBGAlpha = 8 * 256 / 100;
  45 const uint64_t SignalBase::ConversionBlockSize = 4096;
  46 const uint32_t SignalBase::ConversionDelay = 1000;  // 1 second
  47
  48 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
  49         channel_(channel),
  50         channel_type_(channel_type),
  51         conversion_type_(NoConversion),
  52         min_value_(0),
  53         max_value_(0)
  54 {
  55         if (channel_)
  56                 internal_name_ = QString::fromStdString(channel_->name());
  57
  58         connect(&delayed_conversion_starter_, SIGNAL(timeout()),
  59                 this, SLOT(on_delayed_conversion_start()));
  60         delayed_conversion_starter_.setSingleShot(true);
  61         delayed_conversion_starter_.setInterval(ConversionDelay);
  62 }
  63
  64 SignalBase::~SignalBase()
  65 {
  66         stop_conversion();
  67 }
  68
  69 shared_ptr<sigrok::Channel> SignalBase::channel() const
  70 {
  71         return channel_;
  72 }
  73
  74 QString SignalBase::name() const
  75 {
  76         return (channel_) ? QString::fromStdString(channel_->name()) : name_;
  77 }
  78
  79 QString SignalBase::internal_name() const
  80 {
  81         return internal_name_;
  82 }
  83
  84 void SignalBase::set_name(QString name)
  85 {
  86         if (channel_)
  87                 channel_->set_name(name.toUtf8().constData());
  88
  89         name_ = name;
  90
  91         name_changed(name);
  92 }
  93
  94 bool SignalBase::enabled() const
  95 {
  96         return (channel_) ? channel_->enabled() : true;
  97 }
  98
  99 void SignalBase::set_enabled(bool value)
 100 {
 101         if (channel_) {
 102                 channel_->set_enabled(value);
 103                 enabled_changed(value);
 104         }
 105 }
 106
 107 SignalBase::ChannelType SignalBase::type() const
 108 {
 109         return channel_type_;
 110 }
 111
 112 unsigned int SignalBase::index() const
 113 {
 114         return (channel_) ? channel_->index() : 0;
 115 }
 116
 117 unsigned int SignalBase::logic_bit_index() const
 118 {
 119         if (channel_type_ == LogicChannel)
 120                 return channel_->index();
 121         else
 122                 return 0;
 123 }
 124
 125 QColor SignalBase::colour() const
 126 {
 127         return colour_;
 128 }
 129
 130 void SignalBase::set_colour(QColor colour)
 131 {
 132         colour_ = colour;
 133
 134         bgcolour_ = colour;
 135         bgcolour_.setAlpha(ColourBGAlpha);
 136
 137         colour_changed(colour);
 138 }
 139
 140 QColor SignalBase::bgcolour() const
 141 {
 142         return bgcolour_;
 143 }
 144
 145 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
 146 {
 147         if (data_) {
 148                 disconnect(data.get(), SIGNAL(samples_cleared()),
 149                         this, SLOT(on_samples_cleared()));
 150                 disconnect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
 151                         this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
 152
 153                 if (channel_type_ == AnalogChannel) {
 154                         shared_ptr<Analog> analog = analog_data();
 155                         assert(analog);
 156
 157                         disconnect(analog.get(), SIGNAL(min_max_changed(float, float)),
 158                                 this, SLOT(on_min_max_changed(float, float)));
 159                 }
 160         }
 161
 162         data_ = data;
 163
 164         if (data_) {
 165                 connect(data.get(), SIGNAL(samples_cleared()),
 166                         this, SLOT(on_samples_cleared()));
 167                 connect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
 168                         this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
 169
 170                 if (channel_type_ == AnalogChannel) {
 171                         shared_ptr<Analog> analog = analog_data();
 172                         assert(analog);
 173
 174                         connect(analog.get(), SIGNAL(min_max_changed(float, float)),
 175                                 this, SLOT(on_min_max_changed(float, float)));
 176                 }
 177         }
 178 }
 179
 180 shared_ptr<data::Analog> SignalBase::analog_data() const
 181 {
 182         shared_ptr<Analog> result = nullptr;
 183
 184         if (channel_type_ == AnalogChannel)
 185                 result = dynamic_pointer_cast<Analog>(data_);
 186
 187         return result;
 188 }
 189
 190 shared_ptr<data::Logic> SignalBase::logic_data() const
 191 {
 192         shared_ptr<Logic> result = nullptr;
 193
 194         if (channel_type_ == LogicChannel)
 195                 result = dynamic_pointer_cast<Logic>(data_);
 196
 197         if (((conversion_type_ == A2LConversionByThreshold) ||
 198                 (conversion_type_ == A2LConversionBySchmittTrigger)))
 199                 result = dynamic_pointer_cast<Logic>(converted_data_);
 200
 201         return result;
 202 }
 203
 204 SignalBase::ConversionType SignalBase::get_conversion_type() const
 205 {
 206         return conversion_type_;
 207 }
 208
 209 void SignalBase::set_conversion_type(ConversionType t)
 210 {
 211         if (conversion_type_ != NoConversion) {
 212                 stop_conversion();
 213
 214                 // Discard converted data
 215                 converted_data_.reset();
 216                 samples_cleared();
 217         }
 218
 219         conversion_type_ = t;
 220
 221         // Re-create an empty container
 222         // so that the signal is recognized as providing logic data
 223         // and thus can be assigned to a decoder
 224         if (conversion_is_a2l())
 225                 if (!converted_data_)
 226                         converted_data_ = make_shared<Logic>(1);  // Contains only one channel
 227
 228         start_conversion();
 229
 230         conversion_type_changed(t);
 231 }
 232
 233 map<QString, QVariant> SignalBase::get_conversion_options() const
 234 {
 235         return conversion_options_;
 236 }
 237
 238 bool SignalBase::set_conversion_option(QString key, QVariant value)
 239 {
 240         QVariant old_value;
 241
 242         auto key_iter = conversion_options_.find(key);
 243         if (key_iter != conversion_options_.end())
 244                 old_value = key_iter->second;
 245
 246         conversion_options_[key] = value;
 247
 248         return (value != old_value);
 249 }
 250
 251 vector<double> SignalBase::get_conversion_thresholds(const ConversionType t,
 252         const bool always_custom) const
 253 {
 254         vector<double> result;
 255         ConversionType conv_type = t;
 256         ConversionPreset preset;
 257
 258         // Use currently active conversion if no conversion type was supplied
 259         if (conv_type == NoConversion)
 260                 conv_type = conversion_type_;
 261
 262         if (always_custom)
 263                 preset = NoPreset;
 264         else
 265                 preset = get_current_conversion_preset();
 266
 267         if (conv_type == A2LConversionByThreshold) {
 268                 double thr = 0;
 269
 270                 if (preset == NoPreset) {
 271                         auto thr_iter = conversion_options_.find("threshold_value");
 272                         if (thr_iter != conversion_options_.end())
 273                                 thr = (thr_iter->second).toDouble();
 274                 }
 275
 276                 if (preset == DynamicPreset)
 277                         thr = (min_value_ + max_value_) * 0.5;  // middle between min and max
 278
 279                 if ((int)preset == 1) thr = 0.9;
 280                 if ((int)preset == 2) thr = 1.8;
 281                 if ((int)preset == 3) thr = 2.5;
 282                 if ((int)preset == 4) thr = 1.5;
 283
 284                 result.push_back(thr);
 285         }
 286
 287         if (conv_type == A2LConversionBySchmittTrigger) {
 288                 double thr_lo = 0, thr_hi = 0;
 289
 290                 if (preset == NoPreset) {
 291                         auto thr_lo_iter = conversion_options_.find("threshold_value_low");
 292                         if (thr_lo_iter != conversion_options_.end())
 293                                 thr_lo = (thr_lo_iter->second).toDouble();
 294
 295                         auto thr_hi_iter = conversion_options_.find("threshold_value_high");
 296                         if (thr_hi_iter != conversion_options_.end())
 297                                 thr_hi = (thr_hi_iter->second).toDouble();
 298                 }
 299
 300                 if (preset == DynamicPreset) {
 301                         const double amplitude = max_value_ - min_value_;
 302                         const double center = min_value_ + (amplitude / 2);
 303                         thr_lo = center - (amplitude * 0.15);  // 15% margin
 304                         thr_hi = center + (amplitude * 0.15);  // 15% margin
 305                 }
 306
 307                 if ((int)preset == 1) { thr_lo = 0.3; thr_hi = 1.2; }
 308                 if ((int)preset == 2) { thr_lo = 0.7; thr_hi = 2.5; }
 309                 if ((int)preset == 3) { thr_lo = 1.3; thr_hi = 3.7; }
 310                 if ((int)preset == 4) { thr_lo = 0.8; thr_hi = 2.0; }
 311
 312                 result.push_back(thr_lo);
 313                 result.push_back(thr_hi);
 314         }
 315
 316         return result;
 317 }
 318
 319 vector< pair<QString, int> > SignalBase::get_conversion_presets() const
 320 {
 321         vector< pair<QString, int> > presets;
 322
 323         if (conversion_type_ == A2LConversionByThreshold) {
 324                 // Source: http://www.interfacebus.com/voltage_threshold.html
 325                 presets.emplace_back(tr("Signal average"), 0);
 326                 presets.emplace_back(tr("0.9V (for 1.8V CMOS)"), 1);
 327                 presets.emplace_back(tr("1.8V (for 3.3V CMOS)"), 2);
 328                 presets.emplace_back(tr("2.5V (for 5.0V CMOS)"), 3);
 329                 presets.emplace_back(tr("1.5V (for TTL)"), 4);
 330         }
 331
 332         if (conversion_type_ == A2LConversionBySchmittTrigger) {
 333                 // Source: http://www.interfacebus.com/voltage_threshold.html
 334                 presets.emplace_back(tr("Signal average +/- 15%"), 0);
 335                 presets.emplace_back(tr("0.3V/1.2V (for 1.8V CMOS)"), 1);
 336                 presets.emplace_back(tr("0.7V/2.5V (for 3.3V CMOS)"), 2);
 337                 presets.emplace_back(tr("1.3V/3.7V (for 5.0V CMOS)"), 3);
 338                 presets.emplace_back(tr("0.8V/2.0V (for TTL)"), 4);
 339         }
 340
 341         return presets;
 342 }
 343
 344 SignalBase::ConversionPreset SignalBase::get_current_conversion_preset() const
 345 {
 346         auto preset = conversion_options_.find("preset");
 347         if (preset != conversion_options_.end())
 348                 return (ConversionPreset)((preset->second).toInt());
 349
 350         return DynamicPreset;
 351 }
 352
 353 void SignalBase::set_conversion_preset(ConversionPreset id)
 354 {
 355         conversion_options_["preset"] = (int)id;
 356 }
 357
 358 #ifdef ENABLE_DECODE
 359 bool SignalBase::is_decode_signal() const
 360 {
 361         return (channel_type_ == DecodeChannel);
 362 }
 363 #endif
 364
 365 void SignalBase::save_settings(QSettings &settings) const
 366 {
 367         settings.setValue("name", name());
 368         settings.setValue("enabled", enabled());
 369         settings.setValue("colour", colour());
 370         settings.setValue("conversion_type", (int)conversion_type_);
 371
 372         settings.setValue("conv_options", (int)(conversion_options_.size()));
 373         int i = 0;
 374         for (auto kvp : conversion_options_) {
 375                 settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
 376                 settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
 377                 i++;
 378         }
 379 }
 380
 381 void SignalBase::restore_settings(QSettings &settings)
 382 {
 383         set_name(settings.value("name").toString());
 384         set_enabled(settings.value("enabled").toBool());
 385         set_colour(settings.value("colour").value<QColor>());
 386         set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
 387
 388         int conv_options = settings.value("conv_options").toInt();
 389
 390         if (conv_options)
 391                 for (int i = 0; i < conv_options; i++) {
 392                         QString key = settings.value(QString("conv_option%1_key").arg(i)).toString();
 393                         QVariant value = settings.value(QString("conv_option%1_value").arg(i));
 394                         conversion_options_[key] = value;
 395                 }
 396 }
 397
 398 bool SignalBase::conversion_is_a2l() const
 399 {
 400         return ((channel_type_ == AnalogChannel) &&
 401                 ((conversion_type_ == A2LConversionByThreshold) ||
 402                 (conversion_type_ == A2LConversionBySchmittTrigger)));
 403 }
 404
 405 void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
 406 {
 407         uint64_t start_sample, end_sample;
 408         start_sample = end_sample = 0;
 409
 410         start_sample = lsegment->get_sample_count();
 411         end_sample = asegment->get_sample_count();
 412
 413         if (end_sample > start_sample) {
 414                 tie(min_value_, max_value_) = asegment->get_min_max();
 415
 416                 // Create sigrok::Analog instance
 417                 float *asamples = new float[ConversionBlockSize];
 418                 uint8_t *lsamples = new uint8_t[ConversionBlockSize];
 419
 420                 vector<shared_ptr<sigrok::Channel> > channels;
 421                 channels.push_back(channel_);
 422
 423                 vector<const sigrok::QuantityFlag*> mq_flags;
 424                 const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
 425                 const sigrok::Unit * const unit = sigrok::Unit::VOLT;
 426
 427                 shared_ptr<sigrok::Packet> packet =
 428                         Session::sr_context->create_analog_packet(channels,
 429                         asamples, ConversionBlockSize, mq, unit, mq_flags);
 430
 431                 shared_ptr<sigrok::Analog> analog =
 432                         dynamic_pointer_cast<sigrok::Analog>(packet->payload());
 433
 434                 // Convert
 435                 uint64_t i = start_sample;
 436
 437                 if (conversion_type_ == A2LConversionByThreshold) {
 438                         const double threshold = get_conversion_thresholds()[0];
 439
 440                         // Convert as many sample blocks as we can
 441                         while ((end_sample - i) > ConversionBlockSize) {
 442                                 asegment->get_samples(i, i + ConversionBlockSize, asamples);
 443
 444                                 shared_ptr<sigrok::Logic> logic =
 445                                         analog->get_logic_via_threshold(threshold, lsamples);
 446
 447                                 lsegment->append_payload(logic->data_pointer(), logic->data_length());
 448
 449                                 samples_added(lsegment, i, i + ConversionBlockSize);
 450                                 i += ConversionBlockSize;
 451                         }
 452
 453                         // Re-create sigrok::Analog and convert remaining samples
 454                         packet = Session::sr_context->create_analog_packet(channels,
 455                                 asamples, end_sample - i, mq, unit, mq_flags);
 456
 457                         analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
 458
 459                         asegment->get_samples(i, end_sample, asamples);
 460                         shared_ptr<sigrok::Logic> logic =
 461                                 analog->get_logic_via_threshold(threshold, lsamples);
 462                         lsegment->append_payload(logic->data_pointer(), logic->data_length());
 463                         samples_added(lsegment, i, end_sample);
 464                 }
 465
 466                 if (conversion_type_ == A2LConversionBySchmittTrigger) {
 467                         const vector<double> thresholds = get_conversion_thresholds();
 468                         const double lo_thr = thresholds[0];
 469                         const double hi_thr = thresholds[1];
 470
 471                         uint8_t state = 0;  // TODO Use value of logic sample n-1 instead of 0
 472
 473                         // Convert as many sample blocks as we can
 474                         while ((end_sample - i) > ConversionBlockSize) {
 475                                 asegment->get_samples(i, i + ConversionBlockSize, asamples);
 476
 477                                 shared_ptr<sigrok::Logic> logic =
 478                                         analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
 479                                                 &state, lsamples);
 480
 481                                 lsegment->append_payload(logic->data_pointer(), logic->data_length());
 482
 483                                 samples_added(lsegment, i, i + ConversionBlockSize);
 484                                 i += ConversionBlockSize;
 485                         }
 486
 487                         // Re-create sigrok::Analog and convert remaining samples
 488                         packet = Session::sr_context->create_analog_packet(channels,
 489                                 asamples, end_sample - i, mq, unit, mq_flags);
 490
 491                         analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
 492
 493                         asegment->get_samples(i, end_sample, asamples);
 494                         shared_ptr<sigrok::Logic> logic =
 495                                 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
 496                                         &state, lsamples);
 497                         lsegment->append_payload(logic->data_pointer(), logic->data_length());
 498                         samples_added(lsegment, i, end_sample);
 499                 }
 500
 501                 // If acquisition is ongoing, start-/endsample may have changed
 502                 end_sample = asegment->get_sample_count();
 503
 504                 delete[] lsamples;
 505                 delete[] asamples;
 506         }
 507 }
 508
 509 void SignalBase::conversion_thread_proc()
 510 {
 511         shared_ptr<Analog> analog_data;
 512
 513         if (conversion_is_a2l()) {
 514                 analog_data = dynamic_pointer_cast<Analog>(data_);
 515
 516                 if (analog_data->analog_segments().size() == 0)
 517                         return;
 518
 519         } else
 520                 // Currently, we only handle A2L conversions
 521                 return;
 522
 523         uint32_t segment_id = 0;
 524
 525         AnalogSegment *asegment = analog_data->analog_segments().front().get();
 526         assert(asegment);
 527
 528         const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
 529         assert(logic_data);
 530
 531         // Create the initial logic data segment if needed
 532         if (logic_data->logic_segments().size() == 0) {
 533                 shared_ptr<LogicSegment> new_segment =
 534                         make_shared<LogicSegment>(*logic_data.get(), 1, asegment->samplerate());
 535                 logic_data->push_segment(new_segment);
 536         }
 537
 538         LogicSegment *lsegment = logic_data->logic_segments().front().get();
 539         assert(lsegment);
 540
 541         do {
 542                 convert_single_segment(asegment, lsegment);
 543
 544                 if (analog_data->analog_segments().size() > logic_data->logic_segments().size()) {
 545                         // There are more segments to process
 546                         segment_id++;
 547
 548                         try {
 549                                 asegment = analog_data->analog_segments().at(segment_id).get();
 550                         } catch (out_of_range) {
 551                                 qDebug() << "Conversion error for" << name() << ": no analog segment" \
 552                                         << segment_id << ", segments size is" << analog_data->analog_segments().size();
 553                                 return;
 554                         }
 555
 556                         shared_ptr<LogicSegment> new_segment =
 557                                 make_shared<LogicSegment>(*logic_data.get(), 1, asegment->samplerate());
 558                         logic_data->push_segment(new_segment);
 559
 560                         lsegment = logic_data->logic_segments().back().get();
 561                 } else {
 562                         // No more segments to process, wait for data or interrupt
 563                         if (!conversion_interrupt_) {
 564                                 unique_lock<mutex> input_lock(conversion_input_mutex_);
 565                                 conversion_input_cond_.wait(input_lock);
 566                         }
 567                 }
 568         } while (!conversion_interrupt_);
 569 }
 570
 571 void SignalBase::start_conversion(bool delayed_start)
 572 {
 573         if (delayed_start) {
 574                 delayed_conversion_starter_.start();
 575                 return;
 576         }
 577
 578         stop_conversion();
 579
 580         if (converted_data_)
 581                 converted_data_->clear();
 582         samples_cleared();
 583
 584         conversion_interrupt_ = false;
 585         conversion_thread_ = std::thread(
 586                 &SignalBase::conversion_thread_proc, this);
 587 }
 588
 589 void SignalBase::stop_conversion()
 590 {
 591         // Stop conversion so we can restart it from the beginning
 592         conversion_interrupt_ = true;
 593         conversion_input_cond_.notify_one();
 594         if (conversion_thread_.joinable())
 595                 conversion_thread_.join();
 596 }
 597
 598 void SignalBase::on_samples_cleared()
 599 {
 600         if (converted_data_)
 601                 converted_data_->clear();
 602
 603         samples_cleared();
 604 }
 605
 606 void SignalBase::on_samples_added(QObject* segment, uint64_t start_sample,
 607         uint64_t end_sample)
 608 {
 609         if (conversion_type_ != NoConversion) {
 610                 if (conversion_thread_.joinable()) {
 611                         // Notify the conversion thread since it's running
 612                         conversion_input_cond_.notify_one();
 613                 } else {
 614                         // Start the conversion thread unless the delay timer is running
 615                         if (!delayed_conversion_starter_.isActive())
 616                                 start_conversion();
 617                 }
 618         }
 619
 620         samples_added(segment, start_sample, end_sample);
 621 }
 622
 623 void SignalBase::on_min_max_changed(float min, float max)
 624 {
 625         // Restart conversion if one is enabled and uses a calculated threshold
 626         if ((conversion_type_ != NoConversion) &&
 627                 (get_current_conversion_preset() == DynamicPreset))
 628                 start_conversion(true);
 629
 630         min_max_changed(min, max);
 631 }
 632
 633 void SignalBase::on_capture_state_changed(int state)
 634 {
 635         if (state == Session::Running) {
 636                 // Restart conversion if one is enabled
 637                 if (conversion_type_ != NoConversion)
 638                         start_conversion();
 639         }
 640 }
 641
 642 void SignalBase::on_delayed_conversion_start()
 643 {
 644         start_conversion();
 645 }
 646
 647 } // namespace data
 648 } // namespace pv