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 shared_ptr<Analog> analog = analog_data();
230 disconnect(analog.get(), SIGNAL(min_max_changed(float, float)),
231 this, SLOT(on_min_max_changed(float, float)));
237 connect(data.get(), SIGNAL(samples_cleared()),
238 this, SLOT(on_samples_cleared()));
239 connect(data.get(), SIGNAL(samples_added(SharedPtrToSegment, uint64_t, uint64_t)),
240 this, SLOT(on_samples_added(SharedPtrToSegment, uint64_t, uint64_t)));
242 shared_ptr<Analog> analog = analog_data();
244 connect(analog.get(), SIGNAL(min_max_changed(float, float)),
245 this, SLOT(on_min_max_changed(float, float)));
249 void SignalBase::clear_sample_data()
252 analog_data()->clear();
255 logic_data()->clear();
258 shared_ptr<data::Analog> SignalBase::analog_data() const
260 return dynamic_pointer_cast<Analog>(data_);
263 shared_ptr<data::Logic> SignalBase::logic_data() const
265 shared_ptr<Logic> result = dynamic_pointer_cast<Logic>(data_);
267 if (((conversion_type_ == A2LConversionByThreshold) ||
268 (conversion_type_ == A2LConversionBySchmittTrigger)))
269 result = dynamic_pointer_cast<Logic>(converted_data_);
274 bool SignalBase::segment_is_complete(uint32_t segment_id) const
278 shared_ptr<Analog> adata = analog_data();
281 auto segments = adata->analog_segments();
283 result = segments.at(segment_id)->is_complete();
284 } catch (out_of_range&) {
288 shared_ptr<Logic> ldata = logic_data();
290 shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
291 auto segments = data->logic_segments();
293 result = segments.at(segment_id)->is_complete();
294 } catch (out_of_range&) {
303 bool SignalBase::has_samples() const
307 shared_ptr<Analog> adata = analog_data();
310 auto segments = adata->analog_segments();
311 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
314 shared_ptr<Logic> ldata = logic_data();
316 auto segments = ldata->logic_segments();
317 if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
325 double SignalBase::get_samplerate() const
327 shared_ptr<Analog> adata = analog_data();
329 return adata->get_samplerate();
331 shared_ptr<Logic> ldata = logic_data();
333 return ldata->get_samplerate();
336 // Default samplerate is 1 Hz
340 SignalBase::ConversionType SignalBase::get_conversion_type() const
342 return conversion_type_;
345 void SignalBase::set_conversion_type(ConversionType t)
347 if (conversion_type_ != NoConversion) {
350 // Discard converted data
351 converted_data_.reset();
355 conversion_type_ = t;
357 // Re-create an empty container
358 // so that the signal is recognized as providing logic data
359 // and thus can be assigned to a decoder
360 if (conversion_is_a2l())
361 if (!converted_data_)
362 converted_data_ = make_shared<Logic>(1); // Contains only one channel
366 conversion_type_changed(t);
369 map<QString, QVariant> SignalBase::get_conversion_options() const
371 return conversion_options_;
374 bool SignalBase::set_conversion_option(QString key, QVariant value)
378 auto key_iter = conversion_options_.find(key);
379 if (key_iter != conversion_options_.end())
380 old_value = key_iter->second;
382 conversion_options_[key] = value;
384 return (value != old_value);
387 vector<double> SignalBase::get_conversion_thresholds(const ConversionType t,
388 const bool always_custom) const
390 vector<double> result;
391 ConversionType conv_type = t;
392 ConversionPreset preset;
394 // Use currently active conversion if no conversion type was supplied
395 if (conv_type == NoConversion)
396 conv_type = conversion_type_;
401 preset = get_current_conversion_preset();
403 if (conv_type == A2LConversionByThreshold) {
406 if (preset == NoPreset) {
407 auto thr_iter = conversion_options_.find("threshold_value");
408 if (thr_iter != conversion_options_.end())
409 thr = (thr_iter->second).toDouble();
412 if (preset == DynamicPreset)
413 thr = (min_value_ + max_value_) * 0.5; // middle between min and max
415 if ((int)preset == 1) thr = 0.9;
416 if ((int)preset == 2) thr = 1.8;
417 if ((int)preset == 3) thr = 2.5;
418 if ((int)preset == 4) thr = 1.5;
420 result.push_back(thr);
423 if (conv_type == A2LConversionBySchmittTrigger) {
424 double thr_lo = 0, thr_hi = 0;
426 if (preset == NoPreset) {
427 auto thr_lo_iter = conversion_options_.find("threshold_value_low");
428 if (thr_lo_iter != conversion_options_.end())
429 thr_lo = (thr_lo_iter->second).toDouble();
431 auto thr_hi_iter = conversion_options_.find("threshold_value_high");
432 if (thr_hi_iter != conversion_options_.end())
433 thr_hi = (thr_hi_iter->second).toDouble();
436 if (preset == DynamicPreset) {
437 const double amplitude = max_value_ - min_value_;
438 const double center = min_value_ + (amplitude / 2);
439 thr_lo = center - (amplitude * 0.15); // 15% margin
440 thr_hi = center + (amplitude * 0.15); // 15% margin
443 if ((int)preset == 1) { thr_lo = 0.3; thr_hi = 1.2; }
444 if ((int)preset == 2) { thr_lo = 0.7; thr_hi = 2.5; }
445 if ((int)preset == 3) { thr_lo = 1.3; thr_hi = 3.7; }
446 if ((int)preset == 4) { thr_lo = 0.8; thr_hi = 2.0; }
448 result.push_back(thr_lo);
449 result.push_back(thr_hi);
455 vector< pair<QString, int> > SignalBase::get_conversion_presets() const
457 vector< pair<QString, int> > presets;
459 if (conversion_type_ == A2LConversionByThreshold) {
460 // Source: http://www.interfacebus.com/voltage_threshold.html
461 presets.emplace_back(tr("Signal average"), 0);
462 presets.emplace_back(tr("0.9V (for 1.8V CMOS)"), 1);
463 presets.emplace_back(tr("1.8V (for 3.3V CMOS)"), 2);
464 presets.emplace_back(tr("2.5V (for 5.0V CMOS)"), 3);
465 presets.emplace_back(tr("1.5V (for TTL)"), 4);
468 if (conversion_type_ == A2LConversionBySchmittTrigger) {
469 // Source: http://www.interfacebus.com/voltage_threshold.html
470 presets.emplace_back(tr("Signal average +/- 15%"), 0);
471 presets.emplace_back(tr("0.3V/1.2V (for 1.8V CMOS)"), 1);
472 presets.emplace_back(tr("0.7V/2.5V (for 3.3V CMOS)"), 2);
473 presets.emplace_back(tr("1.3V/3.7V (for 5.0V CMOS)"), 3);
474 presets.emplace_back(tr("0.8V/2.0V (for TTL)"), 4);
480 SignalBase::ConversionPreset SignalBase::get_current_conversion_preset() const
482 auto preset = conversion_options_.find("preset");
483 if (preset != conversion_options_.end())
484 return (ConversionPreset)((preset->second).toInt());
486 return DynamicPreset;
489 void SignalBase::set_conversion_preset(ConversionPreset id)
491 conversion_options_["preset"] = (int)id;
495 bool SignalBase::is_decode_signal() const
497 return (channel_type_ == DecodeChannel);
501 void SignalBase::save_settings(QSettings &settings) const
503 settings.setValue("name", name());
504 settings.setValue("enabled", enabled());
505 settings.setValue("color", color().rgba());
506 settings.setValue("conversion_type", (int)conversion_type_);
508 settings.setValue("conv_options", (int)(conversion_options_.size()));
510 for (auto& kvp : conversion_options_) {
511 settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
512 settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
517 void SignalBase::restore_settings(QSettings &settings)
519 if (settings.contains("name"))
520 set_name(settings.value("name").toString());
522 if (settings.contains("enabled"))
523 set_enabled(settings.value("enabled").toBool());
525 if (settings.contains("color")) {
526 QVariant value = settings.value("color");
528 // Workaround for Qt QColor serialization bug on OSX
529 if ((QMetaType::Type)(value.type()) == QMetaType::QColor)
530 set_color(value.value<QColor>());
532 set_color(QColor::fromRgba(value.value<uint32_t>()));
534 // A color with an alpha value of 0 makes the signal marker invisible
535 if (color() == QColor(0, 0, 0, 0))
539 if (settings.contains("conversion_type"))
540 set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
542 int conv_options = 0;
543 if (settings.contains("conv_options"))
544 conv_options = settings.value("conv_options").toInt();
547 for (int i = 0; i < conv_options; i++) {
548 const QString key_id = QString("conv_option%1_key").arg(i);
549 const QString value_id = QString("conv_option%1_value").arg(i);
551 if (settings.contains(key_id) && settings.contains(value_id))
552 conversion_options_[settings.value(key_id).toString()] =
553 settings.value(value_id);
557 bool SignalBase::conversion_is_a2l() const
559 return (((conversion_type_ == A2LConversionByThreshold) ||
560 (conversion_type_ == A2LConversionBySchmittTrigger)));
563 void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
564 LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample)
566 if (end_sample > start_sample) {
567 tie(min_value_, max_value_) = asegment->get_min_max();
569 // Create sigrok::Analog instance
570 float *asamples = new float[ConversionBlockSize];
571 uint8_t *lsamples = new uint8_t[ConversionBlockSize];
573 vector<shared_ptr<sigrok::Channel> > channels;
574 channels.push_back(channel_);
576 vector<const sigrok::QuantityFlag*> mq_flags;
577 const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
578 const sigrok::Unit * const unit = sigrok::Unit::VOLT;
580 shared_ptr<sigrok::Packet> packet =
581 Session::sr_context->create_analog_packet(channels,
582 asamples, ConversionBlockSize, mq, unit, mq_flags);
584 shared_ptr<sigrok::Analog> analog =
585 dynamic_pointer_cast<sigrok::Analog>(packet->payload());
588 uint64_t i = start_sample;
590 if (conversion_type_ == A2LConversionByThreshold) {
591 const double threshold = get_conversion_thresholds()[0];
593 // Convert as many sample blocks as we can
594 while ((end_sample - i) > ConversionBlockSize) {
595 asegment->get_samples(i, i + ConversionBlockSize, asamples);
597 shared_ptr<sigrok::Logic> logic =
598 analog->get_logic_via_threshold(threshold, lsamples);
600 lsegment->append_payload(logic->data_pointer(), logic->data_length());
601 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
602 i += ConversionBlockSize;
605 // Re-create sigrok::Analog and convert remaining samples
606 packet = Session::sr_context->create_analog_packet(channels,
607 asamples, end_sample - i, mq, unit, mq_flags);
609 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
611 asegment->get_samples(i, end_sample, asamples);
612 shared_ptr<sigrok::Logic> logic =
613 analog->get_logic_via_threshold(threshold, lsamples);
614 lsegment->append_payload(logic->data_pointer(), logic->data_length());
615 samples_added(lsegment->segment_id(), i, end_sample);
618 if (conversion_type_ == A2LConversionBySchmittTrigger) {
619 const vector<double> thresholds = get_conversion_thresholds();
620 const double lo_thr = thresholds[0];
621 const double hi_thr = thresholds[1];
623 uint8_t state = 0; // TODO Use value of logic sample n-1 instead of 0
625 // Convert as many sample blocks as we can
626 while ((end_sample - i) > ConversionBlockSize) {
627 asegment->get_samples(i, i + ConversionBlockSize, asamples);
629 shared_ptr<sigrok::Logic> logic =
630 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
633 lsegment->append_payload(logic->data_pointer(), logic->data_length());
634 samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
635 i += ConversionBlockSize;
638 // Re-create sigrok::Analog and convert remaining samples
639 packet = Session::sr_context->create_analog_packet(channels,
640 asamples, end_sample - i, mq, unit, mq_flags);
642 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
644 asegment->get_samples(i, end_sample, asamples);
645 shared_ptr<sigrok::Logic> logic =
646 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
648 lsegment->append_payload(logic->data_pointer(), logic->data_length());
649 samples_added(lsegment->segment_id(), i, end_sample);
652 // If acquisition is ongoing, start-/endsample may have changed
653 end_sample = asegment->get_sample_count();
660 void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
662 uint64_t start_sample, end_sample, old_end_sample;
663 start_sample = end_sample = 0;
664 bool complete_state, old_complete_state;
666 start_sample = lsegment->get_sample_count();
667 end_sample = asegment->get_sample_count();
668 complete_state = asegment->is_complete();
670 // Don't do anything if the segment is still being filled and the sample count is too small
671 if ((!complete_state) && (end_sample - start_sample < ConversionBlockSize))
675 convert_single_segment_range(asegment, lsegment, start_sample, end_sample);
677 old_end_sample = end_sample;
678 old_complete_state = complete_state;
680 start_sample = lsegment->get_sample_count();
681 end_sample = asegment->get_sample_count();
682 complete_state = asegment->is_complete();
684 // If the segment has been incomplete when we were called and has been
685 // completed in the meanwhile, we convert the remaining samples as well.
686 // Also, if a sufficient number of samples was added in the meanwhile,
687 // we do another round of sample conversion.
688 } while ((complete_state != old_complete_state) ||
689 (end_sample - old_end_sample >= ConversionBlockSize));
692 void SignalBase::conversion_thread_proc()
694 shared_ptr<Analog> analog_data;
696 if (conversion_is_a2l()) {
697 analog_data = dynamic_pointer_cast<Analog>(data_);
699 if (analog_data->analog_segments().size() == 0) {
700 unique_lock<mutex> input_lock(conversion_input_mutex_);
701 conversion_input_cond_.wait(input_lock);
705 // Currently, we only handle A2L conversions
708 // If we had to wait for input data, we may have been notified to terminate
709 if (conversion_interrupt_)
712 uint32_t segment_id = 0;
714 AnalogSegment *asegment = analog_data->analog_segments().front().get();
717 const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
720 // Create the initial logic data segment if needed
721 if (logic_data->logic_segments().size() == 0) {
722 shared_ptr<LogicSegment> new_segment =
723 make_shared<LogicSegment>(*logic_data.get(), 0, 1, asegment->samplerate());
724 logic_data->push_segment(new_segment);
727 LogicSegment *lsegment = logic_data->logic_segments().front().get();
731 convert_single_segment(asegment, lsegment);
733 // Only advance to next segment if the current input segment is complete
734 if (asegment->is_complete() &&
735 analog_data->analog_segments().size() > logic_data->logic_segments().size()) {
736 // There are more segments to process
740 asegment = analog_data->analog_segments().at(segment_id).get();
741 } catch (out_of_range&) {
742 qDebug() << "Conversion error for" << name() << ": no analog segment" \
743 << segment_id << ", segments size is" << analog_data->analog_segments().size();
747 shared_ptr<LogicSegment> new_segment = make_shared<LogicSegment>(
748 *logic_data.get(), segment_id, 1, asegment->samplerate());
749 logic_data->push_segment(new_segment);
751 lsegment = logic_data->logic_segments().back().get();
753 // No more samples/segments to process, wait for data or interrupt
754 if (!conversion_interrupt_) {
755 unique_lock<mutex> input_lock(conversion_input_mutex_);
756 conversion_input_cond_.wait(input_lock);
759 } while (!conversion_interrupt_);
762 void SignalBase::start_conversion(bool delayed_start)
765 delayed_conversion_starter_.start();
772 converted_data_->clear();
775 conversion_interrupt_ = false;
776 conversion_thread_ = std::thread(
777 &SignalBase::conversion_thread_proc, this);
780 void SignalBase::stop_conversion()
782 // Stop conversion so we can restart it from the beginning
783 conversion_interrupt_ = true;
784 conversion_input_cond_.notify_one();
785 if (conversion_thread_.joinable())
786 conversion_thread_.join();
789 void SignalBase::on_samples_cleared()
792 converted_data_->clear();
797 void SignalBase::on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
800 if (conversion_type_ != NoConversion) {
801 if (conversion_thread_.joinable()) {
802 // Notify the conversion thread since it's running
803 conversion_input_cond_.notify_one();
805 // Start the conversion thread unless the delay timer is running
806 if (!delayed_conversion_starter_.isActive())
811 samples_added(segment->segment_id(), start_sample, end_sample);
814 void SignalBase::on_min_max_changed(float min, float max)
816 // Restart conversion if one is enabled and uses a calculated threshold
817 if ((conversion_type_ != NoConversion) &&
818 (get_current_conversion_preset() == DynamicPreset))
819 start_conversion(true);
821 min_max_changed(min, max);
824 void SignalBase::on_capture_state_changed(int state)
826 if (state == Session::Running) {
827 // Restart conversion if one is enabled
828 if (conversion_type_ != NoConversion)
833 void SignalBase::on_delayed_conversion_start()