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"
29 #include <pv/binding/decoder.hpp>
30 #include <pv/session.hpp>
32 using std::dynamic_pointer_cast;
33 using std::make_shared;
34 using std::shared_ptr;
36 using std::unique_lock;
41 const int SignalBase::ColourBGAlpha = 8 * 256 / 100;
42 const uint64_t SignalBase::ConversionBlockSize = 4096;
44 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
46 channel_type_(channel_type),
47 conversion_type_(NoConversion),
52 internal_name_ = QString::fromStdString(channel_->name());
55 SignalBase::~SignalBase()
60 shared_ptr<sigrok::Channel> SignalBase::channel() const
65 QString SignalBase::name() const
67 return (channel_) ? QString::fromStdString(channel_->name()) : name_;
70 QString SignalBase::internal_name() const
72 return internal_name_;
75 void SignalBase::set_name(QString name)
78 channel_->set_name(name.toUtf8().constData());
85 bool SignalBase::enabled() const
87 return (channel_) ? channel_->enabled() : true;
90 void SignalBase::set_enabled(bool value)
93 channel_->set_enabled(value);
94 enabled_changed(value);
98 SignalBase::ChannelType SignalBase::type() const
100 return channel_type_;
103 unsigned int SignalBase::index() const
105 return (channel_) ? channel_->index() : 0;
108 unsigned int SignalBase::logic_bit_index() const
110 if (channel_type_ == LogicChannel)
111 return channel_->index();
116 QColor SignalBase::colour() const
121 void SignalBase::set_colour(QColor colour)
126 bgcolour_.setAlpha(ColourBGAlpha);
128 colour_changed(colour);
131 QColor SignalBase::bgcolour() const
136 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
139 disconnect(data.get(), SIGNAL(samples_cleared()),
140 this, SLOT(on_samples_cleared()));
141 disconnect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
142 this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
148 connect(data.get(), SIGNAL(samples_cleared()),
149 this, SLOT(on_samples_cleared()));
150 connect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
151 this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
155 shared_ptr<data::Analog> SignalBase::analog_data() const
157 shared_ptr<Analog> result = nullptr;
159 if (channel_type_ == AnalogChannel)
160 result = dynamic_pointer_cast<Analog>(data_);
165 shared_ptr<data::Logic> SignalBase::logic_data() const
167 shared_ptr<Logic> result = nullptr;
169 if (channel_type_ == LogicChannel)
170 result = dynamic_pointer_cast<Logic>(data_);
172 if (((conversion_type_ == A2LConversionByTreshold) ||
173 (conversion_type_ == A2LConversionBySchmittTrigger)))
174 result = dynamic_pointer_cast<Logic>(converted_data_);
179 SignalBase::ConversionType SignalBase::get_conversion_type() const
181 return conversion_type_;
184 void SignalBase::set_conversion_type(ConversionType t)
186 if (conversion_type_ != NoConversion) {
189 // Discard converted data
190 converted_data_.reset();
194 conversion_type_ = t;
196 // Re-create an empty container
197 // so that the signal is recognized as providing logic data
198 // and thus can be assigned to a decoder
199 if (conversion_is_a2l())
200 if (!converted_data_)
201 converted_data_ = make_shared<Logic>(1); // Contains only one channel
205 conversion_type_changed(t);
208 map<QString, QVariant> SignalBase::get_conversion_options() const
210 return conversion_options_;
213 bool SignalBase::set_conversion_option(QString key, QVariant value)
217 auto key_iter = conversion_options_.find(key);
218 if (key_iter != conversion_options_.end())
219 old_value = key_iter->second;
221 conversion_options_[key] = value;
223 return (value != old_value);
226 vector<double> SignalBase::get_conversion_thresholds(const ConversionType t,
227 const bool always_custom) const
229 vector<double> result;
230 ConversionType conv_type = t;
233 // Use currently active conversion if no conversion type was supplied
234 if (conv_type == NoConversion)
235 conv_type = conversion_type_;
240 preset = get_current_conversion_preset();
242 if (conv_type == A2LConversionByTreshold) {
246 auto thr_iter = conversion_options_.find("threshold_value");
247 if (thr_iter != conversion_options_.end())
248 thr = (thr_iter->second).toDouble();
252 thr = (min_value_ + max_value_) * 0.5; // middle between min and max
254 if (preset == 1) thr = 0.9;
255 if (preset == 2) thr = 1.8;
256 if (preset == 3) thr = 2.5;
257 if (preset == 4) thr = 1.5;
259 result.push_back(thr);
262 if (conv_type == A2LConversionBySchmittTrigger) {
263 double thr_lo = 0, thr_hi = 0;
266 auto thr_lo_iter = conversion_options_.find("threshold_value_low");
267 if (thr_lo_iter != conversion_options_.end())
268 thr_lo = (thr_lo_iter->second).toDouble();
270 auto thr_hi_iter = conversion_options_.find("threshold_value_high");
271 if (thr_hi_iter != conversion_options_.end())
272 thr_hi = (thr_hi_iter->second).toDouble();
276 const double amplitude = max_value_ - min_value_;
277 const double center = min_value_ + (amplitude / 2);
278 thr_lo = center - (amplitude * 0.15); // 15% margin
279 thr_hi = center + (amplitude * 0.15); // 15% margin
282 if (preset == 1) { thr_lo = 0.3; thr_hi = 1.2; }
283 if (preset == 2) { thr_lo = 0.7; thr_hi = 2.5; }
284 if (preset == 3) { thr_lo = 1.3; thr_hi = 3.7; }
285 if (preset == 4) { thr_lo = 0.8; thr_hi = 2.0; }
287 result.push_back(thr_lo);
288 result.push_back(thr_hi);
294 vector< pair<QString, int> > SignalBase::get_conversion_presets() const
296 vector< pair<QString, int> > presets;
298 if (conversion_type_ == A2LConversionByTreshold) {
299 // Source: http://www.interfacebus.com/voltage_threshold.html
300 presets.emplace_back(tr("Signal average"), 0);
301 presets.emplace_back(tr("0.9V (for 1.8V CMOS)"), 1);
302 presets.emplace_back(tr("1.8V (for 3.3V CMOS)"), 2);
303 presets.emplace_back(tr("2.5V (for 5.0V CMOS)"), 3);
304 presets.emplace_back(tr("1.5V (for TTL)"), 4);
307 if (conversion_type_ == A2LConversionBySchmittTrigger) {
308 // Source: http://www.interfacebus.com/voltage_threshold.html
309 presets.emplace_back(tr("Signal average +/- 15%"), 0);
310 presets.emplace_back(tr("0.3V/1.2V (for 1.8V CMOS)"), 1);
311 presets.emplace_back(tr("0.7V/2.5V (for 3.3V CMOS)"), 2);
312 presets.emplace_back(tr("1.3V/3.7V (for 5.0V CMOS)"), 3);
313 presets.emplace_back(tr("0.8V/2.0V (for TTL)"), 4);
319 int SignalBase::get_current_conversion_preset() const
321 auto preset = conversion_options_.find("preset");
322 if (preset != conversion_options_.end())
323 return (preset->second).toInt();
328 void SignalBase::set_conversion_preset(int id)
330 conversion_options_["preset"] = id;
334 bool SignalBase::is_decode_signal() const
336 return (channel_type_ == DecodeChannel);
340 void SignalBase::save_settings(QSettings &settings) const
342 settings.setValue("name", name());
343 settings.setValue("enabled", enabled());
344 settings.setValue("colour", colour());
345 settings.setValue("conversion_type", (int)conversion_type_);
347 settings.setValue("conv_options", (int)(conversion_options_.size()));
349 for (auto kvp : conversion_options_) {
350 settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
351 settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
356 void SignalBase::restore_settings(QSettings &settings)
358 set_name(settings.value("name").toString());
359 set_enabled(settings.value("enabled").toBool());
360 set_colour(settings.value("colour").value<QColor>());
361 set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
363 int conv_options = settings.value("conv_options").toInt();
366 for (int i = 0; i < conv_options; i++) {
367 QString key = settings.value(QString("conv_option%1_key").arg(i)).toString();
368 QVariant value = settings.value(QString("conv_option%1_value").arg(i));
369 conversion_options_[key] = value;
373 bool SignalBase::conversion_is_a2l() const
375 return ((channel_type_ == AnalogChannel) &&
376 ((conversion_type_ == A2LConversionByTreshold) ||
377 (conversion_type_ == A2LConversionBySchmittTrigger)));
380 void SignalBase::conversion_thread_proc(QObject* segment)
382 // TODO Support for multiple segments is missing
384 uint64_t start_sample, end_sample;
385 start_sample = end_sample = 0;
388 if (conversion_is_a2l()) {
390 AnalogSegment *asegment = qobject_cast<AnalogSegment*>(segment);
392 const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
394 // Create the initial logic data segment if needed
395 if (logic_data->segments().size() == 0) {
396 shared_ptr<LogicSegment> lsegment =
397 make_shared<LogicSegment>(*logic_data.get(), 1, asegment->samplerate());
398 logic_data->push_segment(lsegment);
401 LogicSegment *lsegment = dynamic_cast<LogicSegment*>(logic_data->segments().front().get());
403 start_sample = lsegment->get_sample_count();
404 end_sample = asegment->get_sample_count();
406 if (end_sample > start_sample) {
407 tie(min_value_, max_value_) = asegment->get_min_max();
409 // Create sigrok::Analog instance
410 float *asamples = new float[ConversionBlockSize];
411 uint8_t *lsamples = new uint8_t[ConversionBlockSize];
413 vector<shared_ptr<sigrok::Channel> > channels;
414 channels.push_back(channel_);
416 vector<const sigrok::QuantityFlag*> mq_flags;
417 const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
418 const sigrok::Unit * const unit = sigrok::Unit::VOLT;
420 shared_ptr<sigrok::Packet> packet =
421 Session::sr_context->create_analog_packet(channels,
422 asamples, ConversionBlockSize, mq, unit, mq_flags);
424 shared_ptr<sigrok::Analog> analog =
425 dynamic_pointer_cast<sigrok::Analog>(packet->payload());
428 uint64_t i = start_sample;
430 if (conversion_type_ == A2LConversionByTreshold) {
431 const double threshold = get_conversion_thresholds()[0];
433 // Convert as many sample blocks as we can
434 while ((end_sample - i) > ConversionBlockSize) {
435 asegment->get_samples(i, i + ConversionBlockSize, asamples);
437 shared_ptr<sigrok::Logic> logic =
438 analog->get_logic_via_threshold(threshold, lsamples);
440 lsegment->append_payload(logic->data_pointer(), logic->data_length());
442 samples_added(lsegment, i, i + ConversionBlockSize);
443 i += ConversionBlockSize;
446 // Re-create sigrok::Analog and convert remaining samples
447 packet = Session::sr_context->create_analog_packet(channels,
448 asamples, end_sample - i, mq, unit, mq_flags);
450 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
452 asegment->get_samples(i, end_sample, asamples);
453 shared_ptr<sigrok::Logic> logic =
454 analog->get_logic_via_threshold(threshold, lsamples);
455 lsegment->append_payload(logic->data_pointer(), logic->data_length());
456 samples_added(lsegment, i, end_sample);
459 if (conversion_type_ == A2LConversionBySchmittTrigger) {
460 const vector<double> thresholds = get_conversion_thresholds();
461 const double lo_thr = thresholds[0];
462 const double hi_thr = thresholds[1];
464 uint8_t state = 0; // TODO Use value of logic sample n-1 instead of 0
466 // Convert as many sample blocks as we can
467 while ((end_sample - i) > ConversionBlockSize) {
468 asegment->get_samples(i, i + ConversionBlockSize, asamples);
470 shared_ptr<sigrok::Logic> logic =
471 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
474 lsegment->append_payload(logic->data_pointer(), logic->data_length());
476 samples_added(lsegment, i, i + ConversionBlockSize);
477 i += ConversionBlockSize;
480 // Re-create sigrok::Analog and convert remaining samples
481 packet = Session::sr_context->create_analog_packet(channels,
482 asamples, end_sample - i, mq, unit, mq_flags);
484 analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
486 asegment->get_samples(i, end_sample, asamples);
487 shared_ptr<sigrok::Logic> logic =
488 analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
490 lsegment->append_payload(logic->data_pointer(), logic->data_length());
491 samples_added(lsegment, i, end_sample);
494 // If acquisition is ongoing, start-/endsample may have changed
495 end_sample = asegment->get_sample_count();
502 if (!conversion_interrupt_ && (start_sample == end_sample)) {
503 unique_lock<mutex> input_lock(conversion_input_mutex_);
504 conversion_input_cond_.wait(input_lock);
506 } while (!conversion_interrupt_);
509 void SignalBase::start_conversion()
514 converted_data_->clear();
516 if (conversion_is_a2l()) {
517 shared_ptr<Analog> analog_data = dynamic_pointer_cast<Analog>(data_);
519 if (analog_data->analog_segments().size() > 0) {
520 // TODO Support for multiple segments is missing
521 AnalogSegment *asegment = analog_data->analog_segments().front().get();
523 conversion_interrupt_ = false;
524 conversion_thread_ = std::thread(
525 &SignalBase::conversion_thread_proc, this, asegment);
530 void SignalBase::stop_conversion()
532 // Stop conversion so we can restart it from the beginning
533 conversion_interrupt_ = true;
534 conversion_input_cond_.notify_one();
535 if (conversion_thread_.joinable())
536 conversion_thread_.join();
539 void SignalBase::on_samples_cleared()
542 converted_data_->clear();
547 void SignalBase::on_samples_added(QObject* segment, uint64_t start_sample,
550 if (conversion_type_ != NoConversion) {
551 if (conversion_thread_.joinable()) {
552 // Notify the conversion thread since it's running
553 conversion_input_cond_.notify_one();
555 // Start the conversion thread
560 samples_added(segment, start_sample, end_sample);
563 void SignalBase::on_capture_state_changed(int state)
565 if (state == Session::Running) {
566 if (conversion_type_ != NoConversion) {
567 // Restart conversion