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
93 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
95 channel_type_(channel_type),
97 conversion_type_(NoConversion),
102 internal_name_ = QString::fromStdString(channel_->name());
103 index_ = channel_->index();
106 connect(&delayed_conversion_starter_, SIGNAL(timeout()),
107 this, SLOT(on_delayed_conversion_start()));
108 delayed_conversion_starter_.setSingleShot(true);
109 delayed_conversion_starter_.setInterval(ConversionDelay);
112 SignalBase::~SignalBase()
117 shared_ptr<sigrok::Channel> SignalBase::channel() const
122 bool SignalBase::enabled() const
124 return (channel_) ? channel_->enabled() : true;
127 void SignalBase::set_enabled(bool value)
130 channel_->set_enabled(value);
131 enabled_changed(value);
135 SignalBase::ChannelType SignalBase::type() const
137 return channel_type_;
140 unsigned int SignalBase::index() const
145 void SignalBase::set_index(unsigned int index)
150 unsigned int SignalBase::logic_bit_index() const
152 if (channel_type_ == LogicChannel)
158 void SignalBase::set_group(SignalGroup* group)
163 SignalGroup* SignalBase::group() const
168 QString SignalBase::name() const
170 return (channel_) ? QString::fromStdString(channel_->name()) : name_;
173 QString SignalBase::internal_name() const
175 return internal_name_;
178 void SignalBase::set_internal_name(QString internal_name)
180 internal_name_ = internal_name;
183 QString SignalBase::display_name() const
185 if ((name() != internal_name_) && (!internal_name_.isEmpty()))
186 return name() + " (" + internal_name_ + ")";
191 void SignalBase::set_name(QString name)
194 channel_->set_name(name.toUtf8().constData());
201 QColor SignalBase::color() const
206 void SignalBase::set_color(QColor color)
211 bgcolor_.setAlpha(ColorBGAlpha);
213 color_changed(color);
216 QColor SignalBase::bgcolor() const
221 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
224 disconnect(data.get(), SIGNAL(samples_cleared()),
225 this, SLOT(on_samples_cleared()));
226 disconnect(data.get(), SIGNAL(samples_added(shared_ptr<Segment>, uint64_t, uint64_t)),
227 this, SLOT(on_samples_added(shared_ptr<Segment>, uint64_t, uint64_t)));
229 if (channel_type_ == AnalogChannel) {
230 shared_ptr<Analog> analog = analog_data();
233 disconnect(analog.get(), SIGNAL(min_max_changed(float, float)),
234 this, SLOT(on_min_max_changed(float, float)));
241 connect(data.get(), SIGNAL(samples_cleared()),
242 this, SLOT(on_samples_cleared()));
243 connect(data.get(), SIGNAL(samples_added(SharedPtrToSegment, uint64_t, uint64_t)),
244 this, SLOT(on_samples_added(SharedPtrToSegment, uint64_t, uint64_t)));
246 if (channel_type_ == AnalogChannel) {
247 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)));
256 void SignalBase::clear_sample_data()
259 analog_data()->clear();
262 logic_data()->clear();
265 shared_ptr<data::Analog> SignalBase::analog_data() const
267 shared_ptr<Analog> result = nullptr;
269 if (channel_type_ == AnalogChannel)
270 result = dynamic_pointer_cast<Analog>(data_);
275 shared_ptr<data::Logic> SignalBase::logic_data() const
277 shared_ptr<Logic> result = nullptr;
279 if (channel_type_ == LogicChannel)
280 result = dynamic_pointer_cast<Logic>(data_);
282 if (((conversion_type_ == A2LConversionByThreshold) ||
283 (conversion_type_ == A2LConversionBySchmittTrigger)))
284 result = dynamic_pointer_cast<Logic>(converted_data_);
289 bool SignalBase::segment_is_complete(uint32_t segment_id) const
293 if (channel_type_ == AnalogChannel)
295 shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
296 auto segments = data->analog_segments();
298 result = segments.at(segment_id)->is_complete();
299 } catch (out_of_range&) {
304 if (channel_type_ == LogicChannel)
306 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
307 auto segments = data->logic_segments();
309 result = segments.at(segment_id)->is_complete();
310 } catch (out_of_range&) {
318 bool SignalBase::has_samples() const
322 if (channel_type_ == AnalogChannel)
324 shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
326 auto segments = data->analog_segments();
327 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
332 if (channel_type_ == LogicChannel)
334 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
336 auto segments = data->logic_segments();
337 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
345 double SignalBase::get_samplerate() const
347 if (channel_type_ == AnalogChannel)
349 shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
351 return data->get_samplerate();
354 if (channel_type_ == LogicChannel)
356 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
358 return data->get_samplerate();
361 // Default samplerate is 1 Hz
365 SignalBase::ConversionType SignalBase::get_conversion_type() const
367 return conversion_type_;
370 void SignalBase::set_conversion_type(ConversionType t)
372 if (conversion_type_ != NoConversion) {
375 // Discard converted data
376 converted_data_.reset();
380 conversion_type_ = t;
382 // Re-create an empty container
383 // so that the signal is recognized as providing logic data
384 // and thus can be assigned to a decoder
385 if (conversion_is_a2l())
386 if (!converted_data_)
387 converted_data_ = make_shared<Logic>(1); // Contains only one channel
391 conversion_type_changed(t);
394 map<QString, QVariant> SignalBase::get_conversion_options() const
396 return conversion_options_;
399 bool SignalBase::set_conversion_option(QString key, QVariant value)
403 auto key_iter = conversion_options_.find(key);
404 if (key_iter != conversion_options_.end())
405 old_value = key_iter->second;
407 conversion_options_[key] = value;
409 return (value != old_value);
412 vector<double> SignalBase::get_conversion_thresholds(const ConversionType t,
413 const bool always_custom) const
415 vector<double> result;
416 ConversionType conv_type = t;
417 ConversionPreset preset;
419 // Use currently active conversion if no conversion type was supplied
420 if (conv_type == NoConversion)
421 conv_type = conversion_type_;
426 preset = get_current_conversion_preset();
428 if (conv_type == A2LConversionByThreshold) {
431 if (preset == NoPreset) {
432 auto thr_iter = conversion_options_.find("threshold_value");
433 if (thr_iter != conversion_options_.end())
434 thr = (thr_iter->second).toDouble();
437 if (preset == DynamicPreset)
438 thr = (min_value_ + max_value_) * 0.5; // middle between min and max
440 if ((int)preset == 1) thr = 0.9;
441 if ((int)preset == 2) thr = 1.8;
442 if ((int)preset == 3) thr = 2.5;
443 if ((int)preset == 4) thr = 1.5;
445 result.push_back(thr);
448 if (conv_type == A2LConversionBySchmittTrigger) {
449 double thr_lo = 0, thr_hi = 0;
451 if (preset == NoPreset) {
452 auto thr_lo_iter = conversion_options_.find("threshold_value_low");
453 if (thr_lo_iter != conversion_options_.end())
454 thr_lo = (thr_lo_iter->second).toDouble();
456 auto thr_hi_iter = conversion_options_.find("threshold_value_high");
457 if (thr_hi_iter != conversion_options_.end())
458 thr_hi = (thr_hi_iter->second).toDouble();
461 if (preset == DynamicPreset) {
462 const double amplitude = max_value_ - min_value_;
463 const double center = min_value_ + (amplitude / 2);
464 thr_lo = center - (amplitude * 0.15); // 15% margin
465 thr_hi = center + (amplitude * 0.15); // 15% margin
468 if ((int)preset == 1) { thr_lo = 0.3; thr_hi = 1.2; }
469 if ((int)preset == 2) { thr_lo = 0.7; thr_hi = 2.5; }
470 if ((int)preset == 3) { thr_lo = 1.3; thr_hi = 3.7; }
471 if ((int)preset == 4) { thr_lo = 0.8; thr_hi = 2.0; }
473 result.push_back(thr_lo);
474 result.push_back(thr_hi);
480 vector< pair<QString, int> > SignalBase::get_conversion_presets() const
482 vector< pair<QString, int> > presets;
484 if (conversion_type_ == A2LConversionByThreshold) {
485 // Source: http://www.interfacebus.com/voltage_threshold.html
486 presets.emplace_back(tr("Signal average"), 0);
487 presets.emplace_back(tr("0.9V (for 1.8V CMOS)"), 1);
488 presets.emplace_back(tr("1.8V (for 3.3V CMOS)"), 2);
489 presets.emplace_back(tr("2.5V (for 5.0V CMOS)"), 3);
490 presets.emplace_back(tr("1.5V (for TTL)"), 4);
493 if (conversion_type_ == A2LConversionBySchmittTrigger) {
494 // Source: http://www.interfacebus.com/voltage_threshold.html
495 presets.emplace_back(tr("Signal average +/- 15%"), 0);
496 presets.emplace_back(tr("0.3V/1.2V (for 1.8V CMOS)"), 1);
497 presets.emplace_back(tr("0.7V/2.5V (for 3.3V CMOS)"), 2);
498 presets.emplace_back(tr("1.3V/3.7V (for 5.0V CMOS)"), 3);
499 presets.emplace_back(tr("0.8V/2.0V (for TTL)"), 4);
505 SignalBase::ConversionPreset SignalBase::get_current_conversion_preset() const
507 auto preset = conversion_options_.find("preset");
508 if (preset != conversion_options_.end())
509 return (ConversionPreset)((preset->second).toInt());
511 return DynamicPreset;
514 void SignalBase::set_conversion_preset(ConversionPreset id)
516 conversion_options_["preset"] = (int)id;
520 bool SignalBase::is_decode_signal() const
522 return (channel_type_ == DecodeChannel);
526 void SignalBase::save_settings(QSettings &settings) const
528 settings.setValue("name", name());
529 settings.setValue("enabled", enabled());
530 settings.setValue("color", color().rgba());
531 settings.setValue("conversion_type", (int)conversion_type_);
533 settings.setValue("conv_options", (int)(conversion_options_.size()));
535 for (auto& kvp : conversion_options_) {
536 settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
537 settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
542 void SignalBase::restore_settings(QSettings &settings)
544 if (settings.contains("name"))
545 set_name(settings.value("name").toString());
547 if (settings.contains("enabled"))
548 set_enabled(settings.value("enabled").toBool());
550 if (settings.contains("color")) {
551 QVariant value = settings.value("color");
553 // Workaround for Qt QColor serialization bug on OSX
554 if ((QMetaType::Type)(value.type()) == QMetaType::QColor)
555 set_color(value.value<QColor>());
557 set_color(QColor::fromRgba(value.value<uint32_t>()));
559 // A color with an alpha value of 0 makes the signal marker invisible
560 if (color() == QColor(0, 0, 0, 0))
564 if (settings.contains("conversion_type"))
565 set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
567 int conv_options = 0;
568 if (settings.contains("conv_options"))
569 conv_options = settings.value("conv_options").toInt();
572 for (int i = 0; i < conv_options; i++) {
573 const QString key_id = QString("conv_option%1_key").arg(i);
574 const QString value_id = QString("conv_option%1_value").arg(i);
576 if (settings.contains(key_id) && settings.contains(value_id))
577 conversion_options_[settings.value(key_id).toString()] =
578 settings.value(value_id);
582 bool SignalBase::conversion_is_a2l() const
584 return ((channel_type_ == AnalogChannel) &&
585 ((conversion_type_ == A2LConversionByThreshold) ||
586 (conversion_type_ == A2LConversionBySchmittTrigger)));
589 void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
590 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample)
592 if (end_sample > start_sample) {
593 tie(min_value_, max_value_) = asegment->get_min_max();
595 // Create sigrok::Analog instance
596 float *asamples = new float[ConversionBlockSize];
597 uint8_t *lsamples = new uint8_t[ConversionBlockSize];
599 vector<shared_ptr<sigrok::Channel> > channels;
600 channels.push_back(channel_);
602 vector<const sigrok::QuantityFlag*> mq_flags;
603 const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
604 const sigrok::Unit * const unit = sigrok::Unit::VOLT;
606 shared_ptr<sigrok::Packet> packet =
607 Session::sr_context->create_analog_packet(channels,
608 asamples, ConversionBlockSize, mq, unit, mq_flags);
610 shared_ptr<sigrok::Analog> analog =
611 dynamic_pointer_cast<sigrok::Analog>(packet->payload());
614 uint64_t i = start_sample;
616 if (conversion_type_ == A2LConversionByThreshold) {
617 const double threshold = get_conversion_thresholds()[0];
619 // Convert as many sample blocks as we can
620 while ((end_sample - i) > ConversionBlockSize) {
621 asegment->get_samples(i, i + ConversionBlockSize, asamples);
623 shared_ptr<sigrok::Logic> logic =
624 analog->get_logic_via_threshold(threshold, lsamples);
626 lsegment->append_payload(logic->data_pointer(), logic->data_length());
627 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
628 i += ConversionBlockSize;
631 // Re-create sigrok::Analog and convert remaining samples
632 packet = Session::sr_context->create_analog_packet(channels,
633 asamples, end_sample - i, mq, unit, mq_flags);
635 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
637 asegment->get_samples(i, end_sample, asamples);
638 shared_ptr<sigrok::Logic> logic =
639 analog->get_logic_via_threshold(threshold, lsamples);
640 lsegment->append_payload(logic->data_pointer(), logic->data_length());
641 samples_added(lsegment->segment_id(), i, end_sample);
644 if (conversion_type_ == A2LConversionBySchmittTrigger) {
645 const vector<double> thresholds = get_conversion_thresholds();
646 const double lo_thr = thresholds[0];
647 const double hi_thr = thresholds[1];
649 uint8_t state = 0; // TODO Use value of logic sample n-1 instead of 0
651 // Convert as many sample blocks as we can
652 while ((end_sample - i) > ConversionBlockSize) {
653 asegment->get_samples(i, i + ConversionBlockSize, asamples);
655 shared_ptr<sigrok::Logic> logic =
656 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
659 lsegment->append_payload(logic->data_pointer(), logic->data_length());
660 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
661 i += ConversionBlockSize;
664 // Re-create sigrok::Analog and convert remaining samples
665 packet = Session::sr_context->create_analog_packet(channels,
666 asamples, end_sample - i, mq, unit, mq_flags);
668 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
670 asegment->get_samples(i, end_sample, asamples);
671 shared_ptr<sigrok::Logic> logic =
672 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
674 lsegment->append_payload(logic->data_pointer(), logic->data_length());
675 samples_added(lsegment->segment_id(), i, end_sample);
678 // If acquisition is ongoing, start-/endsample may have changed
679 end_sample = asegment->get_sample_count();
686 void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
688 uint64_t start_sample, end_sample, old_end_sample;
689 start_sample = end_sample = 0;
690 bool complete_state, old_complete_state;
692 start_sample = lsegment->get_sample_count();
693 end_sample = asegment->get_sample_count();
694 complete_state = asegment->is_complete();
696 // Don't do anything if the segment is still being filled and the sample count is too small
697 if ((!complete_state) && (end_sample - start_sample < ConversionBlockSize))
701 convert_single_segment_range(asegment, lsegment, start_sample, end_sample);
703 old_end_sample = end_sample;
704 old_complete_state = complete_state;
706 start_sample = lsegment->get_sample_count();
707 end_sample = asegment->get_sample_count();
708 complete_state = asegment->is_complete();
710 // If the segment has been incomplete when we were called and has been
711 // completed in the meanwhile, we convert the remaining samples as well.
712 // Also, if a sufficient number of samples was added in the meanwhile,
713 // we do another round of sample conversion.
714 } while ((complete_state != old_complete_state) ||
715 (end_sample - old_end_sample >= ConversionBlockSize));
718 void SignalBase::conversion_thread_proc()
720 shared_ptr<Analog> analog_data;
722 if (conversion_is_a2l()) {
723 analog_data = dynamic_pointer_cast<Analog>(data_);
725 if (analog_data->analog_segments().size() == 0) {
726 unique_lock<mutex> input_lock(conversion_input_mutex_);
727 conversion_input_cond_.wait(input_lock);
731 // Currently, we only handle A2L conversions
734 // If we had to wait for input data, we may have been notified to terminate
735 if (conversion_interrupt_)
738 uint32_t segment_id = 0;
740 AnalogSegment *asegment = analog_data->analog_segments().front().get();
743 const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
746 // Create the initial logic data segment if needed
747 if (logic_data->logic_segments().size() == 0) {
748 shared_ptr<LogicSegment> new_segment =
749 make_shared<LogicSegment>(*logic_data.get(), 0, 1, asegment->samplerate());
750 logic_data->push_segment(new_segment);
753 LogicSegment *lsegment = logic_data->logic_segments().front().get();
757 convert_single_segment(asegment, lsegment);
759 // Only advance to next segment if the current input segment is complete
760 if (asegment->is_complete() &&
761 analog_data->analog_segments().size() > logic_data->logic_segments().size()) {
762 // There are more segments to process
766 asegment = analog_data->analog_segments().at(segment_id).get();
767 } catch (out_of_range&) {
768 qDebug() << "Conversion error for" << name() << ": no analog segment" \
769 << segment_id << ", segments size is" << analog_data->analog_segments().size();
773 shared_ptr<LogicSegment> new_segment = make_shared<LogicSegment>(
774 *logic_data.get(), segment_id, 1, asegment->samplerate());
775 logic_data->push_segment(new_segment);
777 lsegment = logic_data->logic_segments().back().get();
779 // No more samples/segments to process, wait for data or interrupt
780 if (!conversion_interrupt_) {
781 unique_lock<mutex> input_lock(conversion_input_mutex_);
782 conversion_input_cond_.wait(input_lock);
785 } while (!conversion_interrupt_);
788 void SignalBase::start_conversion(bool delayed_start)
791 delayed_conversion_starter_.start();
798 converted_data_->clear();
801 conversion_interrupt_ = false;
802 conversion_thread_ = std::thread(
803 &SignalBase::conversion_thread_proc, this);
806 void SignalBase::stop_conversion()
808 // Stop conversion so we can restart it from the beginning
809 conversion_interrupt_ = true;
810 conversion_input_cond_.notify_one();
811 if (conversion_thread_.joinable())
812 conversion_thread_.join();
815 void SignalBase::on_samples_cleared()
818 converted_data_->clear();
823 void SignalBase::on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
826 if (conversion_type_ != NoConversion) {
827 if (conversion_thread_.joinable()) {
828 // Notify the conversion thread since it's running
829 conversion_input_cond_.notify_one();
831 // Start the conversion thread unless the delay timer is running
832 if (!delayed_conversion_starter_.isActive())
837 samples_added(segment->segment_id(), start_sample, end_sample);
840 void SignalBase::on_min_max_changed(float min, float max)
842 // Restart conversion if one is enabled and uses a calculated threshold
843 if ((conversion_type_ != NoConversion) &&
844 (get_current_conversion_preset() == DynamicPreset))
845 start_conversion(true);
847 min_max_changed(min, max);
850 void SignalBase::on_capture_state_changed(int state)
852 if (state == Session::Running) {
853 // Restart conversion if one is enabled
854 if (conversion_type_ != NoConversion)
859 void SignalBase::on_delayed_conversion_start()