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 <pv/binding/decoder.hpp>
  30 #include <pv/session.hpp>
  31
  32 using std::dynamic_pointer_cast;
  33 using std::make_shared;
  34 using std::shared_ptr;
  35 using std::tie;
  36 using std::unique_lock;
  37
  38 namespace pv {
  39 namespace data {
  40
  41 const int SignalBase::ColourBGAlpha = 8 * 256 / 100;
  42 const uint64_t SignalBase::ConversionBlockSize = 4096;
  43
  44 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
  45         channel_(channel),
  46         channel_type_(channel_type),
  47         conversion_type_(NoConversion)
  48 {
  49         if (channel_)
  50                 internal_name_ = QString::fromStdString(channel_->name());
  51 }
  52
  53 SignalBase::~SignalBase()
  54 {
  55         stop_conversion();
  56 }
  57
  58 shared_ptr<sigrok::Channel> SignalBase::channel() const
  59 {
  60         return channel_;
  61 }
  62
  63 QString SignalBase::name() const
  64 {
  65         return (channel_) ? QString::fromStdString(channel_->name()) : name_;
  66 }
  67
  68 QString SignalBase::internal_name() const
  69 {
  70         return internal_name_;
  71 }
  72
  73 void SignalBase::set_name(QString name)
  74 {
  75         if (channel_)
  76                 channel_->set_name(name.toUtf8().constData());
  77
  78         name_ = name;
  79
  80         name_changed(name);
  81 }
  82
  83 bool SignalBase::enabled() const
  84 {
  85         return (channel_) ? channel_->enabled() : true;
  86 }
  87
  88 void SignalBase::set_enabled(bool value)
  89 {
  90         if (channel_) {
  91                 channel_->set_enabled(value);
  92                 enabled_changed(value);
  93         }
  94 }
  95
  96 SignalBase::ChannelType SignalBase::type() const
  97 {
  98         return channel_type_;
  99 }
 100
 101 unsigned int SignalBase::index() const
 102 {
 103         return (channel_) ? channel_->index() : 0;
 104 }
 105
 106 unsigned int SignalBase::logic_bit_index() const
 107 {
 108         if (channel_type_ == LogicChannel)
 109                 return channel_->index();
 110         else
 111                 return 0;
 112 }
 113
 114 QColor SignalBase::colour() const
 115 {
 116         return colour_;
 117 }
 118
 119 void SignalBase::set_colour(QColor colour)
 120 {
 121         colour_ = colour;
 122
 123         bgcolour_ = colour;
 124         bgcolour_.setAlpha(ColourBGAlpha);
 125
 126         colour_changed(colour);
 127 }
 128
 129 QColor SignalBase::bgcolour() const
 130 {
 131         return bgcolour_;
 132 }
 133
 134 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
 135 {
 136         if (data_) {
 137                 disconnect(data.get(), SIGNAL(samples_cleared()),
 138                         this, SLOT(on_samples_cleared()));
 139                 disconnect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
 140                         this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
 141         }
 142
 143         data_ = data;
 144
 145         if (data_) {
 146                 connect(data.get(), SIGNAL(samples_cleared()),
 147                         this, SLOT(on_samples_cleared()));
 148                 connect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
 149                         this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
 150         }
 151 }
 152
 153 shared_ptr<data::Analog> SignalBase::analog_data() const
 154 {
 155         shared_ptr<Analog> result = nullptr;
 156
 157         if (channel_type_ == AnalogChannel)
 158                 result = dynamic_pointer_cast<Analog>(data_);
 159
 160         return result;
 161 }
 162
 163 shared_ptr<data::Logic> SignalBase::logic_data() const
 164 {
 165         shared_ptr<Logic> result = nullptr;
 166
 167         if (channel_type_ == LogicChannel)
 168                 result = dynamic_pointer_cast<Logic>(data_);
 169
 170         if (((conversion_type_ == A2LConversionByTreshold) ||
 171                 (conversion_type_ == A2LConversionBySchmittTrigger)))
 172                 result = dynamic_pointer_cast<Logic>(converted_data_);
 173
 174         return result;
 175 }
 176
 177 void SignalBase::set_conversion_type(ConversionType t)
 178 {
 179         if (conversion_type_ != NoConversion) {
 180                 stop_conversion();
 181
 182                 // Discard converted data
 183                 converted_data_.reset();
 184         }
 185
 186         conversion_type_ = t;
 187
 188         // Re-create an empty container
 189         // so that the signal is recognized as providing logic data
 190         // and thus can be assigned to a decoder
 191         if (conversion_is_a2l())
 192                 if (!converted_data_)
 193                         converted_data_ = make_shared<Logic>(1);  // Contains only one channel
 194
 195         start_conversion();
 196
 197         conversion_type_changed(t);
 198 }
 199
 200 #ifdef ENABLE_DECODE
 201 bool SignalBase::is_decode_signal() const
 202 {
 203         return (channel_type_ == DecodeChannel);
 204 }
 205 #endif
 206
 207 void SignalBase::save_settings(QSettings &settings) const
 208 {
 209         settings.setValue("name", name());
 210         settings.setValue("enabled", enabled());
 211         settings.setValue("colour", colour());
 212         settings.setValue("conversion_type", (int)conversion_type_);
 213 }
 214
 215 void SignalBase::restore_settings(QSettings &settings)
 216 {
 217         set_name(settings.value("name").toString());
 218         set_enabled(settings.value("enabled").toBool());
 219         set_colour(settings.value("colour").value<QColor>());
 220         set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
 221 }
 222
 223 uint8_t SignalBase::convert_a2l_threshold(float threshold, float value)
 224 {
 225         return (value >= threshold) ? 1 : 0;
 226 }
 227
 228 uint8_t SignalBase::convert_a2l_schmitt_trigger(float lo_thr, float hi_thr,
 229         float value, uint8_t &state)
 230 {
 231         if (value < lo_thr)
 232                 state = 0;
 233         else if (value > hi_thr)
 234                 state = 1;
 235
 236         return state;
 237 }
 238
 239 bool SignalBase::conversion_is_a2l() const
 240 {
 241         return ((channel_type_ == AnalogChannel) &&
 242                 ((conversion_type_ == A2LConversionByTreshold) ||
 243                 (conversion_type_ == A2LConversionBySchmittTrigger)));
 244 }
 245
 246 void SignalBase::conversion_thread_proc(QObject* segment)
 247 {
 248         // TODO Support for multiple segments is missing
 249
 250         uint64_t start_sample, end_sample;
 251         start_sample = end_sample = 0;
 252
 253         do {
 254                 if (conversion_is_a2l()) {
 255
 256                         AnalogSegment *asegment = qobject_cast<AnalogSegment*>(segment);
 257
 258                         const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
 259
 260                         // Create the initial logic data segment if needed
 261                         if (logic_data->segments().size() == 0) {
 262                                 shared_ptr<LogicSegment> lsegment =
 263                                         make_shared<LogicSegment>(*logic_data.get(), 1, asegment->samplerate());
 264                                 logic_data->push_segment(lsegment);
 265                         }
 266
 267                         LogicSegment *lsegment = dynamic_cast<LogicSegment*>(logic_data->segments().front().get());
 268
 269                         start_sample = lsegment->get_sample_count();
 270                         end_sample = asegment->get_sample_count();
 271
 272                         if (end_sample > start_sample) {
 273                                 float min_v, max_v;
 274                                 tie(min_v, max_v) = asegment->get_min_max();
 275
 276                                 vector<uint8_t> lsamples;
 277                                 lsamples.reserve(ConversionBlockSize);
 278
 279                                 uint64_t i = start_sample;
 280
 281                                 if (conversion_type_ == A2LConversionByTreshold) {
 282                                         const float threshold = (min_v + max_v) * 0.5;  // middle between min and max
 283
 284                                         // Convert as many sample blocks as we can
 285                                         while ((end_sample - i) > ConversionBlockSize) {
 286                                                 const float* asamples = asegment->get_samples(i, i + ConversionBlockSize);
 287                                                 for (uint32_t j = 0; j < ConversionBlockSize; j++)
 288                                                         lsamples.push_back(convert_a2l_threshold(threshold, asamples[j]));
 289                                                 lsegment->append_payload(lsamples.data(), lsamples.size());
 290                                                 samples_added(lsegment, i, i + ConversionBlockSize);
 291                                                 i += ConversionBlockSize;
 292                                                 lsamples.clear();
 293                                                 delete[] asamples;
 294                                         }
 295
 296                                         // Convert remaining samples
 297                                         const float* asamples = asegment->get_samples(i, end_sample);
 298                                         for (uint32_t j = 0; j < (end_sample - i); j++)
 299                                                 lsamples.push_back(convert_a2l_threshold(threshold, asamples[j]));
 300                                         lsegment->append_payload(lsamples.data(), lsamples.size());
 301                                         samples_added(lsegment, i, end_sample);
 302                                         delete[] asamples;
 303                                 }
 304
 305                                 if (conversion_type_ == A2LConversionBySchmittTrigger) {
 306                                         const float amplitude = max_v - min_v;
 307                                         const float lo_thr = min_v + (amplitude * 0.1);  // 10% above min
 308                                         const float hi_thr = max_v - (amplitude * 0.1);  // 10% below max
 309                                         uint8_t state = 0;  // TODO Use value of logic sample n-1 instead of 0
 310
 311                                         // Convert as many sample blocks as we can
 312                                         while ((end_sample - i) > ConversionBlockSize) {
 313                                                 const float* asamples = asegment->get_samples(i, i + ConversionBlockSize);
 314                                                 for (uint32_t j = 0; j < ConversionBlockSize; j++)
 315                                                         lsamples.push_back(convert_a2l_schmitt_trigger(lo_thr, hi_thr, asamples[j], state));
 316                                                 lsegment->append_payload(lsamples.data(), lsamples.size());
 317                                                 samples_added(lsegment, i, i + ConversionBlockSize);
 318                                                 i += ConversionBlockSize;
 319                                                 lsamples.clear();
 320                                                 delete[] asamples;
 321                                         }
 322
 323                                         // Convert remaining samples
 324                                         const float* asamples = asegment->get_samples(i, end_sample);
 325                                         for (uint32_t j = 0; j < (end_sample - i); j++)
 326                                                 lsamples.push_back(convert_a2l_schmitt_trigger(lo_thr, hi_thr, asamples[j], state));
 327                                         lsegment->append_payload(lsamples.data(), lsamples.size());
 328                                         samples_added(lsegment, i, end_sample);
 329                                         delete[] asamples;
 330                                 }
 331
 332                                 // If acquisition is ongoing, start-/endsample may have changed
 333                                 end_sample = asegment->get_sample_count();
 334                         }
 335                 }
 336
 337                 if (!conversion_interrupt_ && (start_sample == end_sample)) {
 338                         unique_lock<mutex> input_lock(conversion_input_mutex_);
 339                         conversion_input_cond_.wait(input_lock);
 340                 }
 341         } while (!conversion_interrupt_);
 342 }
 343
 344 void SignalBase::start_conversion()
 345 {
 346         stop_conversion();
 347
 348         if (conversion_is_a2l()) {
 349                 shared_ptr<Analog> analog_data = dynamic_pointer_cast<Analog>(data_);
 350
 351                 if (analog_data->analog_segments().size() > 0) {
 352                         // TODO Support for multiple segments is missing
 353                         AnalogSegment *asegment = analog_data->analog_segments().front().get();
 354
 355                         conversion_interrupt_ = false;
 356                         conversion_thread_ = std::thread(
 357                                 &SignalBase::conversion_thread_proc, this, asegment);
 358                 }
 359         }
 360 }
 361
 362 void SignalBase::stop_conversion()
 363 {
 364         // Stop conversion so we can restart it from the beginning
 365         conversion_interrupt_ = true;
 366         conversion_input_cond_.notify_one();
 367         if (conversion_thread_.joinable())
 368                 conversion_thread_.join();
 369 }
 370
 371 void SignalBase::on_samples_cleared()
 372 {
 373         if (converted_data_)
 374                 converted_data_->clear();
 375
 376         samples_cleared();
 377 }
 378
 379 void SignalBase::on_samples_added(QObject* segment, uint64_t start_sample,
 380         uint64_t end_sample)
 381 {
 382         if (conversion_type_ != NoConversion) {
 383                 if (conversion_thread_.joinable()) {
 384                         // Notify the conversion thread since it's running
 385                         conversion_input_cond_.notify_one();
 386                 } else {
 387                         // Start the conversion thread
 388                         start_conversion();
 389                 }
 390         }
 391
 392         samples_added(segment, start_sample, end_sample);
 393 }
 394
 395 void SignalBase::on_capture_state_changed(int state)
 396 {
 397         if (state == Session::Running) {
 398                 if (conversion_type_ != NoConversion) {
 399                         // Restart conversion
 400                         stop_conversion();
 401                         start_conversion();
 402                 }
 403         }
 404 }
 405
 406 } // namespace data
 407 } // namespace pv