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::is_generated() const
123 // Only signals associated with a device have a corresponding sigrok channel
124 return channel_ == nullptr;
127 bool SignalBase::enabled() const
129 return (channel_) ? channel_->enabled() : true;
132 void SignalBase::set_enabled(bool value)
135 channel_->set_enabled(value);
136 enabled_changed(value);
140 SignalBase::ChannelType SignalBase::type() const
142 return channel_type_;
145 unsigned int SignalBase::index() const
150 void SignalBase::set_index(unsigned int index)
155 unsigned int SignalBase::logic_bit_index() const
157 if (channel_type_ == LogicChannel)
163 void SignalBase::set_group(SignalGroup* group)
168 SignalGroup* SignalBase::group() const
173 QString SignalBase::name() const
175 return (channel_) ? QString::fromStdString(channel_->name()) : name_;
178 QString SignalBase::internal_name() const
180 return internal_name_;
183 void SignalBase::set_internal_name(QString internal_name)
185 internal_name_ = internal_name;
188 QString SignalBase::display_name() const
190 if ((name() != internal_name_) && (!internal_name_.isEmpty()))
191 return name() + " (" + internal_name_ + ")";
196 void SignalBase::set_name(QString name)
199 channel_->set_name(name.toUtf8().constData());
206 QColor SignalBase::color() const
211 void SignalBase::set_color(QColor color)
216 bgcolor_.setAlpha(ColorBGAlpha);
218 color_changed(color);
221 QColor SignalBase::bgcolor() const
226 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
229 disconnect(data.get(), SIGNAL(samples_cleared()),
230 this, SLOT(on_samples_cleared()));
231 disconnect(data.get(), SIGNAL(samples_added(shared_ptr<Segment>, uint64_t, uint64_t)),
232 this, SLOT(on_samples_added(shared_ptr<Segment>, uint64_t, uint64_t)));
234 shared_ptr<Analog> analog = analog_data();
236 disconnect(analog.get(), SIGNAL(min_max_changed(float, float)),
237 this, SLOT(on_min_max_changed(float, float)));
243 connect(data.get(), SIGNAL(samples_cleared()),
244 this, SLOT(on_samples_cleared()));
245 connect(data.get(), SIGNAL(samples_added(SharedPtrToSegment, uint64_t, uint64_t)),
246 this, SLOT(on_samples_added(SharedPtrToSegment, uint64_t, uint64_t)));
248 shared_ptr<Analog> analog = analog_data();
250 connect(analog.get(), SIGNAL(min_max_changed(float, float)),
251 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 return dynamic_pointer_cast<Analog>(data_);
269 shared_ptr<data::Logic> SignalBase::logic_data() const
271 shared_ptr<Logic> result = dynamic_pointer_cast<Logic>(data_);
273 if (((conversion_type_ == A2LConversionByThreshold) ||
274 (conversion_type_ == A2LConversionBySchmittTrigger)))
275 result = dynamic_pointer_cast<Logic>(converted_data_);
280 bool SignalBase::segment_is_complete(uint32_t segment_id) const
284 shared_ptr<Analog> adata = analog_data();
287 auto segments = adata->analog_segments();
289 result = segments.at(segment_id)->is_complete();
290 } catch (out_of_range&) {
294 shared_ptr<Logic> ldata = logic_data();
296 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
297 auto segments = data->logic_segments();
299 result = segments.at(segment_id)->is_complete();
300 } catch (out_of_range&) {
309 bool SignalBase::has_samples() const
313 shared_ptr<Analog> adata = analog_data();
316 auto segments = adata->analog_segments();
317 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
320 shared_ptr<Logic> ldata = logic_data();
322 auto segments = ldata->logic_segments();
323 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
331 double SignalBase::get_samplerate() const
333 shared_ptr<Analog> adata = analog_data();
335 return adata->get_samplerate();
337 shared_ptr<Logic> ldata = logic_data();
339 return ldata->get_samplerate();
342 // Default samplerate is 1 Hz
346 SignalBase::ConversionType SignalBase::get_conversion_type() const
348 return conversion_type_;
351 void SignalBase::set_conversion_type(ConversionType t)
353 if (conversion_type_ != NoConversion) {
356 // Discard converted data
357 converted_data_.reset();
361 conversion_type_ = t;
363 // Re-create an empty container
364 // so that the signal is recognized as providing logic data
365 // and thus can be assigned to a decoder
366 if (conversion_is_a2l())
367 if (!converted_data_)
368 converted_data_ = make_shared<Logic>(1); // Contains only one channel
372 conversion_type_changed(t);
375 map<QString, QVariant> SignalBase::get_conversion_options() const
377 return conversion_options_;
380 bool SignalBase::set_conversion_option(QString key, QVariant value)
384 auto key_iter = conversion_options_.find(key);
385 if (key_iter != conversion_options_.end())
386 old_value = key_iter->second;
388 conversion_options_[key] = value;
390 return (value != old_value);
393 vector<double> SignalBase::get_conversion_thresholds(const ConversionType t,
394 const bool always_custom) const
396 vector<double> result;
397 ConversionType conv_type = t;
398 ConversionPreset preset;
400 // Use currently active conversion if no conversion type was supplied
401 if (conv_type == NoConversion)
402 conv_type = conversion_type_;
407 preset = get_current_conversion_preset();
409 if (conv_type == A2LConversionByThreshold) {
412 if (preset == NoPreset) {
413 auto thr_iter = conversion_options_.find("threshold_value");
414 if (thr_iter != conversion_options_.end())
415 thr = (thr_iter->second).toDouble();
418 if (preset == DynamicPreset)
419 thr = (min_value_ + max_value_) * 0.5; // middle between min and max
421 if ((int)preset == 1) thr = 0.9;
422 if ((int)preset == 2) thr = 1.8;
423 if ((int)preset == 3) thr = 2.5;
424 if ((int)preset == 4) thr = 1.5;
426 result.push_back(thr);
429 if (conv_type == A2LConversionBySchmittTrigger) {
430 double thr_lo = 0, thr_hi = 0;
432 if (preset == NoPreset) {
433 auto thr_lo_iter = conversion_options_.find("threshold_value_low");
434 if (thr_lo_iter != conversion_options_.end())
435 thr_lo = (thr_lo_iter->second).toDouble();
437 auto thr_hi_iter = conversion_options_.find("threshold_value_high");
438 if (thr_hi_iter != conversion_options_.end())
439 thr_hi = (thr_hi_iter->second).toDouble();
442 if (preset == DynamicPreset) {
443 const double amplitude = max_value_ - min_value_;
444 const double center = min_value_ + (amplitude / 2);
445 thr_lo = center - (amplitude * 0.15); // 15% margin
446 thr_hi = center + (amplitude * 0.15); // 15% margin
449 if ((int)preset == 1) { thr_lo = 0.3; thr_hi = 1.2; }
450 if ((int)preset == 2) { thr_lo = 0.7; thr_hi = 2.5; }
451 if ((int)preset == 3) { thr_lo = 1.3; thr_hi = 3.7; }
452 if ((int)preset == 4) { thr_lo = 0.8; thr_hi = 2.0; }
454 result.push_back(thr_lo);
455 result.push_back(thr_hi);
461 vector< pair<QString, int> > SignalBase::get_conversion_presets() const
463 vector< pair<QString, int> > presets;
465 if (conversion_type_ == A2LConversionByThreshold) {
466 // Source: http://www.interfacebus.com/voltage_threshold.html
467 presets.emplace_back(tr("Signal average"), 0);
468 presets.emplace_back(tr("0.9V (for 1.8V CMOS)"), 1);
469 presets.emplace_back(tr("1.8V (for 3.3V CMOS)"), 2);
470 presets.emplace_back(tr("2.5V (for 5.0V CMOS)"), 3);
471 presets.emplace_back(tr("1.5V (for TTL)"), 4);
474 if (conversion_type_ == A2LConversionBySchmittTrigger) {
475 // Source: http://www.interfacebus.com/voltage_threshold.html
476 presets.emplace_back(tr("Signal average +/- 15%"), 0);
477 presets.emplace_back(tr("0.3V/1.2V (for 1.8V CMOS)"), 1);
478 presets.emplace_back(tr("0.7V/2.5V (for 3.3V CMOS)"), 2);
479 presets.emplace_back(tr("1.3V/3.7V (for 5.0V CMOS)"), 3);
480 presets.emplace_back(tr("0.8V/2.0V (for TTL)"), 4);
486 SignalBase::ConversionPreset SignalBase::get_current_conversion_preset() const
488 auto preset = conversion_options_.find("preset");
489 if (preset != conversion_options_.end())
490 return (ConversionPreset)((preset->second).toInt());
492 return DynamicPreset;
495 void SignalBase::set_conversion_preset(ConversionPreset id)
497 conversion_options_["preset"] = (int)id;
501 bool SignalBase::is_decode_signal() const
503 return (channel_type_ == DecodeChannel);
507 void SignalBase::save_settings(QSettings &settings) const
509 settings.setValue("name", name());
510 settings.setValue("enabled", enabled());
511 settings.setValue("color", color().rgba());
512 settings.setValue("conversion_type", (int)conversion_type_);
514 settings.setValue("conv_options", (int)(conversion_options_.size()));
516 for (auto& kvp : conversion_options_) {
517 settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
518 settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
523 void SignalBase::restore_settings(QSettings &settings)
525 if (settings.contains("name"))
526 set_name(settings.value("name").toString());
528 if (settings.contains("enabled"))
529 set_enabled(settings.value("enabled").toBool());
531 if (settings.contains("color")) {
532 QVariant value = settings.value("color");
534 // Workaround for Qt QColor serialization bug on OSX
535 if ((QMetaType::Type)(value.type()) == QMetaType::QColor)
536 set_color(value.value<QColor>());
538 set_color(QColor::fromRgba(value.value<uint32_t>()));
540 // A color with an alpha value of 0 makes the signal marker invisible
541 if (color() == QColor(0, 0, 0, 0))
545 if (settings.contains("conversion_type"))
546 set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
548 int conv_options = 0;
549 if (settings.contains("conv_options"))
550 conv_options = settings.value("conv_options").toInt();
553 for (int i = 0; i < conv_options; i++) {
554 const QString key_id = QString("conv_option%1_key").arg(i);
555 const QString value_id = QString("conv_option%1_value").arg(i);
557 if (settings.contains(key_id) && settings.contains(value_id))
558 conversion_options_[settings.value(key_id).toString()] =
559 settings.value(value_id);
563 bool SignalBase::conversion_is_a2l() const
565 return (((conversion_type_ == A2LConversionByThreshold) ||
566 (conversion_type_ == A2LConversionBySchmittTrigger)));
569 void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
570 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample)
572 if (end_sample > start_sample) {
573 tie(min_value_, max_value_) = asegment->get_min_max();
575 // Create sigrok::Analog instance
576 float *asamples = new float[ConversionBlockSize];
578 uint8_t *lsamples = new uint8_t[ConversionBlockSize];
581 vector<shared_ptr<sigrok::Channel> > channels;
583 channels.push_back(channel_);
585 vector<const sigrok::QuantityFlag*> mq_flags;
586 const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
587 const sigrok::Unit * const unit = sigrok::Unit::VOLT;
589 shared_ptr<sigrok::Packet> packet =
590 Session::sr_context->create_analog_packet(channels,
591 asamples, ConversionBlockSize, mq, unit, mq_flags);
593 shared_ptr<sigrok::Analog> analog =
594 dynamic_pointer_cast<sigrok::Analog>(packet->payload());
597 uint64_t i = start_sample;
599 if (conversion_type_ == A2LConversionByThreshold) {
600 const double threshold = get_conversion_thresholds()[0];
602 // Convert as many sample blocks as we can
603 while ((end_sample - i) > ConversionBlockSize) {
604 asegment->get_samples(i, i + ConversionBlockSize, asamples);
606 shared_ptr<sigrok::Logic> logic =
607 analog->get_logic_via_threshold(threshold, lsamples);
609 lsegment->append_payload(logic->data_pointer(), logic->data_length());
610 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
611 i += ConversionBlockSize;
614 // Re-create sigrok::Analog and convert remaining samples
615 packet = Session::sr_context->create_analog_packet(channels,
616 asamples, end_sample - i, mq, unit, mq_flags);
618 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
620 asegment->get_samples(i, end_sample, asamples);
621 shared_ptr<sigrok::Logic> logic =
622 analog->get_logic_via_threshold(threshold, lsamples);
623 lsegment->append_payload(logic->data_pointer(), logic->data_length());
624 samples_added(lsegment->segment_id(), i, end_sample);
627 if (conversion_type_ == A2LConversionBySchmittTrigger) {
628 const vector<double> thresholds = get_conversion_thresholds();
629 const double lo_thr = thresholds[0];
630 const double hi_thr = thresholds[1];
632 uint8_t state = 0; // TODO Use value of logic sample n-1 instead of 0
634 // Convert as many sample blocks as we can
635 while ((end_sample - i) > ConversionBlockSize) {
636 asegment->get_samples(i, i + ConversionBlockSize, asamples);
638 shared_ptr<sigrok::Logic> logic =
639 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
642 lsegment->append_payload(logic->data_pointer(), logic->data_length());
643 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
644 i += ConversionBlockSize;
647 // Re-create sigrok::Analog and convert remaining samples
648 packet = Session::sr_context->create_analog_packet(channels,
649 asamples, end_sample - i, mq, unit, mq_flags);
651 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
653 asegment->get_samples(i, end_sample, asamples);
654 shared_ptr<sigrok::Logic> logic =
655 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
657 lsegment->append_payload(logic->data_pointer(), logic->data_length());
658 samples_added(lsegment->segment_id(), i, end_sample);
661 // If acquisition is ongoing, start-/endsample may have changed
662 end_sample = asegment->get_sample_count();
669 void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
671 uint64_t start_sample, end_sample, old_end_sample;
672 start_sample = end_sample = 0;
673 bool complete_state, old_complete_state;
675 start_sample = lsegment->get_sample_count();
676 end_sample = asegment->get_sample_count();
677 complete_state = asegment->is_complete();
679 // Don't do anything if the segment is still being filled and the sample count is too small
680 if ((!complete_state) && (end_sample - start_sample < ConversionBlockSize))
684 convert_single_segment_range(asegment, lsegment, start_sample, end_sample);
686 old_end_sample = end_sample;
687 old_complete_state = complete_state;
689 start_sample = lsegment->get_sample_count();
690 end_sample = asegment->get_sample_count();
691 complete_state = asegment->is_complete();
693 // If the segment has been incomplete when we were called and has been
694 // completed in the meanwhile, we convert the remaining samples as well.
695 // Also, if a sufficient number of samples was added in the meanwhile,
696 // we do another round of sample conversion.
697 } while ((complete_state != old_complete_state) ||
698 (end_sample - old_end_sample >= ConversionBlockSize));
701 void SignalBase::conversion_thread_proc()
703 shared_ptr<Analog> analog_data;
705 if (conversion_is_a2l()) {
706 analog_data = dynamic_pointer_cast<Analog>(data_);
708 if (analog_data->analog_segments().size() == 0) {
709 unique_lock<mutex> input_lock(conversion_input_mutex_);
710 conversion_input_cond_.wait(input_lock);
714 // Currently, we only handle A2L conversions
717 // If we had to wait for input data, we may have been notified to terminate
718 if (conversion_interrupt_)
721 uint32_t segment_id = 0;
723 AnalogSegment *asegment = analog_data->analog_segments().front().get();
726 const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
729 // Create the initial logic data segment if needed
730 if (logic_data->logic_segments().size() == 0) {
731 shared_ptr<LogicSegment> new_segment =
732 make_shared<LogicSegment>(*logic_data.get(), 0, 1, asegment->samplerate());
733 logic_data->push_segment(new_segment);
736 LogicSegment *lsegment = logic_data->logic_segments().front().get();
740 convert_single_segment(asegment, lsegment);
742 // Only advance to next segment if the current input segment is complete
743 if (asegment->is_complete() &&
744 analog_data->analog_segments().size() > logic_data->logic_segments().size()) {
745 // There are more segments to process
749 asegment = analog_data->analog_segments().at(segment_id).get();
750 } catch (out_of_range&) {
751 qDebug() << "Conversion error for" << name() << ": no analog segment" \
752 << segment_id << ", segments size is" << analog_data->analog_segments().size();
756 shared_ptr<LogicSegment> new_segment = make_shared<LogicSegment>(
757 *logic_data.get(), segment_id, 1, asegment->samplerate());
758 logic_data->push_segment(new_segment);
760 lsegment = logic_data->logic_segments().back().get();
762 // No more samples/segments to process, wait for data or interrupt
763 if (!conversion_interrupt_) {
764 unique_lock<mutex> input_lock(conversion_input_mutex_);
765 conversion_input_cond_.wait(input_lock);
768 } while (!conversion_interrupt_);
771 void SignalBase::start_conversion(bool delayed_start)
774 delayed_conversion_starter_.start();
781 converted_data_->clear();
784 conversion_interrupt_ = false;
785 conversion_thread_ = std::thread(
786 &SignalBase::conversion_thread_proc, this);
789 void SignalBase::stop_conversion()
791 // Stop conversion so we can restart it from the beginning
792 conversion_interrupt_ = true;
793 conversion_input_cond_.notify_one();
794 if (conversion_thread_.joinable())
795 conversion_thread_.join();
798 void SignalBase::on_samples_cleared()
801 converted_data_->clear();
806 void SignalBase::on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
809 if (conversion_type_ != NoConversion) {
810 if (conversion_thread_.joinable()) {
811 // Notify the conversion thread since it's running
812 conversion_input_cond_.notify_one();
814 // Start the conversion thread unless the delay timer is running
815 if (!delayed_conversion_starter_.isActive())
820 samples_added(segment->segment_id(), start_sample, end_sample);
823 void SignalBase::on_min_max_changed(float min, float max)
825 // Restart conversion if one is enabled and uses a calculated threshold
826 if ((conversion_type_ != NoConversion) &&
827 (get_current_conversion_preset() == DynamicPreset))
828 start_conversion(true);
830 min_max_changed(min, max);
833 void SignalBase::on_capture_state_changed(int state)
835 if (state == Session::Running) {
836 // Restart conversion if one is enabled
837 if (conversion_type_ != NoConversion)
842 void SignalBase::on_delayed_conversion_start()