2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
5 * Copyright (C) 2016 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
22 #include "analogsegment.hpp"
23 #include "decode/row.hpp"
25 #include "logicsegment.hpp"
26 #include "signalbase.hpp"
27 #include "signaldata.hpp"
31 #include <pv/binding/decoder.hpp>
32 #include <pv/session.hpp>
34 using std::dynamic_pointer_cast;
35 using std::make_shared;
36 using std::out_of_range;
37 using std::shared_ptr;
39 using std::unique_lock;
44 const int SignalBase::ColorBGAlpha = 8 * 256 / 100;
45 const uint64_t SignalBase::ConversionBlockSize = 4096;
46 const uint32_t SignalBase::ConversionDelay = 1000; // 1 second
49 SignalGroup::SignalGroup(const QString& name)
54 void SignalGroup::append_signal(shared_ptr<SignalBase> signal)
59 signals_.push_back(signal);
60 signal->set_group(this);
63 void SignalGroup::remove_signal(shared_ptr<SignalBase> signal)
68 signals_.erase(std::remove_if(signals_.begin(), signals_.end(),
69 [&](shared_ptr<SignalBase> s) { return s == signal; }),
73 deque<shared_ptr<SignalBase>> SignalGroup::signals() const
78 void SignalGroup::clear()
80 for (shared_ptr<SignalBase> sb : signals_)
81 sb->set_group(nullptr);
86 const QString SignalGroup::name() const
92 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
94 channel_type_(channel_type),
96 conversion_type_(NoConversion),
101 internal_name_ = QString::fromStdString(channel_->name());
102 index_ = channel_->index();
105 connect(&delayed_conversion_starter_, SIGNAL(timeout()),
106 this, SLOT(on_delayed_conversion_start()));
107 delayed_conversion_starter_.setSingleShot(true);
108 delayed_conversion_starter_.setInterval(ConversionDelay);
111 SignalBase::~SignalBase()
116 shared_ptr<sigrok::Channel> SignalBase::channel() const
121 bool SignalBase::enabled() const
123 return (channel_) ? channel_->enabled() : true;
126 void SignalBase::set_enabled(bool value)
129 channel_->set_enabled(value);
130 enabled_changed(value);
134 SignalBase::ChannelType SignalBase::type() const
136 return channel_type_;
139 unsigned int SignalBase::index() const
144 void SignalBase::set_index(unsigned int index)
149 unsigned int SignalBase::logic_bit_index() const
151 if (channel_type_ == LogicChannel)
157 void SignalBase::set_group(SignalGroup* group)
162 SignalGroup* SignalBase::group() const
167 QString SignalBase::name() const
169 return (channel_) ? QString::fromStdString(channel_->name()) : name_;
172 QString SignalBase::internal_name() const
174 return internal_name_;
177 void SignalBase::set_internal_name(QString internal_name)
179 internal_name_ = internal_name;
182 QString SignalBase::display_name() const
184 if ((name() != internal_name_) && (!internal_name_.isEmpty()))
185 return name() + " (" + internal_name_ + ")";
190 void SignalBase::set_name(QString name)
193 channel_->set_name(name.toUtf8().constData());
200 QColor SignalBase::color() const
205 void SignalBase::set_color(QColor color)
210 bgcolor_.setAlpha(ColorBGAlpha);
212 color_changed(color);
215 QColor SignalBase::bgcolor() const
220 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
223 disconnect(data.get(), SIGNAL(samples_cleared()),
224 this, SLOT(on_samples_cleared()));
225 disconnect(data.get(), SIGNAL(samples_added(shared_ptr<Segment>, uint64_t, uint64_t)),
226 this, SLOT(on_samples_added(shared_ptr<Segment>, uint64_t, uint64_t)));
228 if (channel_type_ == AnalogChannel) {
229 shared_ptr<Analog> analog = analog_data();
232 disconnect(analog.get(), SIGNAL(min_max_changed(float, float)),
233 this, SLOT(on_min_max_changed(float, float)));
240 connect(data.get(), SIGNAL(samples_cleared()),
241 this, SLOT(on_samples_cleared()));
242 connect(data.get(), SIGNAL(samples_added(SharedPtrToSegment, uint64_t, uint64_t)),
243 this, SLOT(on_samples_added(SharedPtrToSegment, uint64_t, uint64_t)));
245 if (channel_type_ == AnalogChannel) {
246 shared_ptr<Analog> analog = analog_data();
249 connect(analog.get(), SIGNAL(min_max_changed(float, float)),
250 this, SLOT(on_min_max_changed(float, float)));
255 void SignalBase::clear_sample_data()
258 analog_data()->clear();
261 logic_data()->clear();
264 shared_ptr<data::Analog> SignalBase::analog_data() const
266 shared_ptr<Analog> result = nullptr;
268 if (channel_type_ == AnalogChannel)
269 result = dynamic_pointer_cast<Analog>(data_);
274 shared_ptr<data::Logic> SignalBase::logic_data() const
276 shared_ptr<Logic> result = nullptr;
278 if (channel_type_ == LogicChannel)
279 result = dynamic_pointer_cast<Logic>(data_);
281 if (((conversion_type_ == A2LConversionByThreshold) ||
282 (conversion_type_ == A2LConversionBySchmittTrigger)))
283 result = dynamic_pointer_cast<Logic>(converted_data_);
288 bool SignalBase::segment_is_complete(uint32_t segment_id) const
292 if (channel_type_ == AnalogChannel)
294 shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
295 auto segments = data->analog_segments();
297 result = segments.at(segment_id)->is_complete();
298 } catch (out_of_range&) {
303 if (channel_type_ == LogicChannel)
305 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
306 auto segments = data->logic_segments();
308 result = segments.at(segment_id)->is_complete();
309 } catch (out_of_range&) {
317 bool SignalBase::has_samples() const
321 if (channel_type_ == AnalogChannel)
323 shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
325 auto segments = data->analog_segments();
326 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
331 if (channel_type_ == LogicChannel)
333 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
335 auto segments = data->logic_segments();
336 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
344 double SignalBase::get_samplerate() const
346 if (channel_type_ == AnalogChannel)
348 shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
350 return data->get_samplerate();
353 if (channel_type_ == LogicChannel)
355 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
357 return data->get_samplerate();
360 // Default samplerate is 1 Hz
364 SignalBase::ConversionType SignalBase::get_conversion_type() const
366 return conversion_type_;
369 void SignalBase::set_conversion_type(ConversionType t)
371 if (conversion_type_ != NoConversion) {
374 // Discard converted data
375 converted_data_.reset();
379 conversion_type_ = t;
381 // Re-create an empty container
382 // so that the signal is recognized as providing logic data
383 // and thus can be assigned to a decoder
384 if (conversion_is_a2l())
385 if (!converted_data_)
386 converted_data_ = make_shared<Logic>(1); // Contains only one channel
390 conversion_type_changed(t);
393 map<QString, QVariant> SignalBase::get_conversion_options() const
395 return conversion_options_;
398 bool SignalBase::set_conversion_option(QString key, QVariant value)
402 auto key_iter = conversion_options_.find(key);
403 if (key_iter != conversion_options_.end())
404 old_value = key_iter->second;
406 conversion_options_[key] = value;
408 return (value != old_value);
411 vector<double> SignalBase::get_conversion_thresholds(const ConversionType t,
412 const bool always_custom) const
414 vector<double> result;
415 ConversionType conv_type = t;
416 ConversionPreset preset;
418 // Use currently active conversion if no conversion type was supplied
419 if (conv_type == NoConversion)
420 conv_type = conversion_type_;
425 preset = get_current_conversion_preset();
427 if (conv_type == A2LConversionByThreshold) {
430 if (preset == NoPreset) {
431 auto thr_iter = conversion_options_.find("threshold_value");
432 if (thr_iter != conversion_options_.end())
433 thr = (thr_iter->second).toDouble();
436 if (preset == DynamicPreset)
437 thr = (min_value_ + max_value_) * 0.5; // middle between min and max
439 if ((int)preset == 1) thr = 0.9;
440 if ((int)preset == 2) thr = 1.8;
441 if ((int)preset == 3) thr = 2.5;
442 if ((int)preset == 4) thr = 1.5;
444 result.push_back(thr);
447 if (conv_type == A2LConversionBySchmittTrigger) {
448 double thr_lo = 0, thr_hi = 0;
450 if (preset == NoPreset) {
451 auto thr_lo_iter = conversion_options_.find("threshold_value_low");
452 if (thr_lo_iter != conversion_options_.end())
453 thr_lo = (thr_lo_iter->second).toDouble();
455 auto thr_hi_iter = conversion_options_.find("threshold_value_high");
456 if (thr_hi_iter != conversion_options_.end())
457 thr_hi = (thr_hi_iter->second).toDouble();
460 if (preset == DynamicPreset) {
461 const double amplitude = max_value_ - min_value_;
462 const double center = min_value_ + (amplitude / 2);
463 thr_lo = center - (amplitude * 0.15); // 15% margin
464 thr_hi = center + (amplitude * 0.15); // 15% margin
467 if ((int)preset == 1) { thr_lo = 0.3; thr_hi = 1.2; }
468 if ((int)preset == 2) { thr_lo = 0.7; thr_hi = 2.5; }
469 if ((int)preset == 3) { thr_lo = 1.3; thr_hi = 3.7; }
470 if ((int)preset == 4) { thr_lo = 0.8; thr_hi = 2.0; }
472 result.push_back(thr_lo);
473 result.push_back(thr_hi);
479 vector< pair<QString, int> > SignalBase::get_conversion_presets() const
481 vector< pair<QString, int> > presets;
483 if (conversion_type_ == A2LConversionByThreshold) {
484 // Source: http://www.interfacebus.com/voltage_threshold.html
485 presets.emplace_back(tr("Signal average"), 0);
486 presets.emplace_back(tr("0.9V (for 1.8V CMOS)"), 1);
487 presets.emplace_back(tr("1.8V (for 3.3V CMOS)"), 2);
488 presets.emplace_back(tr("2.5V (for 5.0V CMOS)"), 3);
489 presets.emplace_back(tr("1.5V (for TTL)"), 4);
492 if (conversion_type_ == A2LConversionBySchmittTrigger) {
493 // Source: http://www.interfacebus.com/voltage_threshold.html
494 presets.emplace_back(tr("Signal average +/- 15%"), 0);
495 presets.emplace_back(tr("0.3V/1.2V (for 1.8V CMOS)"), 1);
496 presets.emplace_back(tr("0.7V/2.5V (for 3.3V CMOS)"), 2);
497 presets.emplace_back(tr("1.3V/3.7V (for 5.0V CMOS)"), 3);
498 presets.emplace_back(tr("0.8V/2.0V (for TTL)"), 4);
504 SignalBase::ConversionPreset SignalBase::get_current_conversion_preset() const
506 auto preset = conversion_options_.find("preset");
507 if (preset != conversion_options_.end())
508 return (ConversionPreset)((preset->second).toInt());
510 return DynamicPreset;
513 void SignalBase::set_conversion_preset(ConversionPreset id)
515 conversion_options_["preset"] = (int)id;
519 bool SignalBase::is_decode_signal() const
521 return (channel_type_ == DecodeChannel);
525 void SignalBase::save_settings(QSettings &settings) const
527 settings.setValue("name", name());
528 settings.setValue("enabled", enabled());
529 settings.setValue("color", color().rgba());
530 settings.setValue("conversion_type", (int)conversion_type_);
532 settings.setValue("conv_options", (int)(conversion_options_.size()));
534 for (auto& kvp : conversion_options_) {
535 settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
536 settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
541 void SignalBase::restore_settings(QSettings &settings)
543 if (settings.contains("name"))
544 set_name(settings.value("name").toString());
546 if (settings.contains("enabled"))
547 set_enabled(settings.value("enabled").toBool());
549 if (settings.contains("color")) {
550 QVariant value = settings.value("color");
552 // Workaround for Qt QColor serialization bug on OSX
553 if ((QMetaType::Type)(value.type()) == QMetaType::QColor)
554 set_color(value.value<QColor>());
556 set_color(QColor::fromRgba(value.value<uint32_t>()));
558 // A color with an alpha value of 0 makes the signal marker invisible
559 if (color() == QColor(0, 0, 0, 0))
563 if (settings.contains("conversion_type"))
564 set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
566 int conv_options = 0;
567 if (settings.contains("conv_options"))
568 conv_options = settings.value("conv_options").toInt();
571 for (int i = 0; i < conv_options; i++) {
572 const QString key_id = QString("conv_option%1_key").arg(i);
573 const QString value_id = QString("conv_option%1_value").arg(i);
575 if (settings.contains(key_id) && settings.contains(value_id))
576 conversion_options_[settings.value(key_id).toString()] =
577 settings.value(value_id);
581 bool SignalBase::conversion_is_a2l() const
583 return ((channel_type_ == AnalogChannel) &&
584 ((conversion_type_ == A2LConversionByThreshold) ||
585 (conversion_type_ == A2LConversionBySchmittTrigger)));
588 void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
589 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample)
591 if (end_sample > start_sample) {
592 tie(min_value_, max_value_) = asegment->get_min_max();
594 // Create sigrok::Analog instance
595 float *asamples = new float[ConversionBlockSize];
596 uint8_t *lsamples = new uint8_t[ConversionBlockSize];
598 vector<shared_ptr<sigrok::Channel> > channels;
599 channels.push_back(channel_);
601 vector<const sigrok::QuantityFlag*> mq_flags;
602 const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
603 const sigrok::Unit * const unit = sigrok::Unit::VOLT;
605 shared_ptr<sigrok::Packet> packet =
606 Session::sr_context->create_analog_packet(channels,
607 asamples, ConversionBlockSize, mq, unit, mq_flags);
609 shared_ptr<sigrok::Analog> analog =
610 dynamic_pointer_cast<sigrok::Analog>(packet->payload());
613 uint64_t i = start_sample;
615 if (conversion_type_ == A2LConversionByThreshold) {
616 const double threshold = get_conversion_thresholds()[0];
618 // Convert as many sample blocks as we can
619 while ((end_sample - i) > ConversionBlockSize) {
620 asegment->get_samples(i, i + ConversionBlockSize, asamples);
622 shared_ptr<sigrok::Logic> logic =
623 analog->get_logic_via_threshold(threshold, lsamples);
625 lsegment->append_payload(logic->data_pointer(), logic->data_length());
626 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
627 i += ConversionBlockSize;
630 // Re-create sigrok::Analog and convert remaining samples
631 packet = Session::sr_context->create_analog_packet(channels,
632 asamples, end_sample - i, mq, unit, mq_flags);
634 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
636 asegment->get_samples(i, end_sample, asamples);
637 shared_ptr<sigrok::Logic> logic =
638 analog->get_logic_via_threshold(threshold, lsamples);
639 lsegment->append_payload(logic->data_pointer(), logic->data_length());
640 samples_added(lsegment->segment_id(), i, end_sample);
643 if (conversion_type_ == A2LConversionBySchmittTrigger) {
644 const vector<double> thresholds = get_conversion_thresholds();
645 const double lo_thr = thresholds[0];
646 const double hi_thr = thresholds[1];
648 uint8_t state = 0; // TODO Use value of logic sample n-1 instead of 0
650 // Convert as many sample blocks as we can
651 while ((end_sample - i) > ConversionBlockSize) {
652 asegment->get_samples(i, i + ConversionBlockSize, asamples);
654 shared_ptr<sigrok::Logic> logic =
655 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
658 lsegment->append_payload(logic->data_pointer(), logic->data_length());
659 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
660 i += ConversionBlockSize;
663 // Re-create sigrok::Analog and convert remaining samples
664 packet = Session::sr_context->create_analog_packet(channels,
665 asamples, end_sample - i, mq, unit, mq_flags);
667 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
669 asegment->get_samples(i, end_sample, asamples);
670 shared_ptr<sigrok::Logic> logic =
671 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
673 lsegment->append_payload(logic->data_pointer(), logic->data_length());
674 samples_added(lsegment->segment_id(), i, end_sample);
677 // If acquisition is ongoing, start-/endsample may have changed
678 end_sample = asegment->get_sample_count();
685 void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
687 uint64_t start_sample, end_sample, old_end_sample;
688 start_sample = end_sample = 0;
689 bool complete_state, old_complete_state;
691 start_sample = lsegment->get_sample_count();
692 end_sample = asegment->get_sample_count();
693 complete_state = asegment->is_complete();
695 // Don't do anything if the segment is still being filled and the sample count is too small
696 if ((!complete_state) && (end_sample - start_sample < ConversionBlockSize))
700 convert_single_segment_range(asegment, lsegment, start_sample, end_sample);
702 old_end_sample = end_sample;
703 old_complete_state = complete_state;
705 start_sample = lsegment->get_sample_count();
706 end_sample = asegment->get_sample_count();
707 complete_state = asegment->is_complete();
709 // If the segment has been incomplete when we were called and has been
710 // completed in the meanwhile, we convert the remaining samples as well.
711 // Also, if a sufficient number of samples was added in the meanwhile,
712 // we do another round of sample conversion.
713 } while ((complete_state != old_complete_state) ||
714 (end_sample - old_end_sample >= ConversionBlockSize));
717 void SignalBase::conversion_thread_proc()
719 shared_ptr<Analog> analog_data;
721 if (conversion_is_a2l()) {
722 analog_data = dynamic_pointer_cast<Analog>(data_);
724 if (analog_data->analog_segments().size() == 0) {
725 unique_lock<mutex> input_lock(conversion_input_mutex_);
726 conversion_input_cond_.wait(input_lock);
730 // Currently, we only handle A2L conversions
733 // If we had to wait for input data, we may have been notified to terminate
734 if (conversion_interrupt_)
737 uint32_t segment_id = 0;
739 AnalogSegment *asegment = analog_data->analog_segments().front().get();
742 const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
745 // Create the initial logic data segment if needed
746 if (logic_data->logic_segments().size() == 0) {
747 shared_ptr<LogicSegment> new_segment =
748 make_shared<LogicSegment>(*logic_data.get(), 0, 1, asegment->samplerate());
749 logic_data->push_segment(new_segment);
752 LogicSegment *lsegment = logic_data->logic_segments().front().get();
756 convert_single_segment(asegment, lsegment);
758 // Only advance to next segment if the current input segment is complete
759 if (asegment->is_complete() &&
760 analog_data->analog_segments().size() > logic_data->logic_segments().size()) {
761 // There are more segments to process
765 asegment = analog_data->analog_segments().at(segment_id).get();
766 } catch (out_of_range&) {
767 qDebug() << "Conversion error for" << name() << ": no analog segment" \
768 << segment_id << ", segments size is" << analog_data->analog_segments().size();
772 shared_ptr<LogicSegment> new_segment = make_shared<LogicSegment>(
773 *logic_data.get(), segment_id, 1, asegment->samplerate());
774 logic_data->push_segment(new_segment);
776 lsegment = logic_data->logic_segments().back().get();
778 // No more samples/segments to process, wait for data or interrupt
779 if (!conversion_interrupt_) {
780 unique_lock<mutex> input_lock(conversion_input_mutex_);
781 conversion_input_cond_.wait(input_lock);
784 } while (!conversion_interrupt_);
787 void SignalBase::start_conversion(bool delayed_start)
790 delayed_conversion_starter_.start();
797 converted_data_->clear();
800 conversion_interrupt_ = false;
801 conversion_thread_ = std::thread(
802 &SignalBase::conversion_thread_proc, this);
805 void SignalBase::stop_conversion()
807 // Stop conversion so we can restart it from the beginning
808 conversion_interrupt_ = true;
809 conversion_input_cond_.notify_one();
810 if (conversion_thread_.joinable())
811 conversion_thread_.join();
814 void SignalBase::on_samples_cleared()
817 converted_data_->clear();
822 void SignalBase::on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
825 if (conversion_type_ != NoConversion) {
826 if (conversion_thread_.joinable()) {
827 // Notify the conversion thread since it's running
828 conversion_input_cond_.notify_one();
830 // Start the conversion thread unless the delay timer is running
831 if (!delayed_conversion_starter_.isActive())
836 samples_added(segment->segment_id(), start_sample, end_sample);
839 void SignalBase::on_min_max_changed(float min, float max)
841 // Restart conversion if one is enabled and uses a calculated threshold
842 if ((conversion_type_ != NoConversion) &&
843 (get_current_conversion_preset() == DynamicPreset))
844 start_conversion(true);
846 min_max_changed(min, max);
849 void SignalBase::on_capture_state_changed(int state)
851 if (state == Session::Running) {
852 // Restart conversion if one is enabled
853 if (conversion_type_ != NoConversion)
858 void SignalBase::on_delayed_conversion_start()