]> sigrok.org Git - pulseview.git/blobdiff - pv/data/signalbase.cpp
Fix random clazy warnings
[pulseview.git] / pv / data / signalbase.cpp
index fe7c584b62b4eab7c58e2383b77989f0bd0194da..9f35725f8df1cc540e032680cb70d31b4fe6b5ad 100644 (file)
 #include "signalbase.hpp"
 #include "signaldata.hpp"
 
+#include <QDebug>
+
 #include <pv/binding/decoder.hpp>
 #include <pv/session.hpp>
 
 using std::dynamic_pointer_cast;
 using std::make_shared;
+using std::out_of_range;
 using std::shared_ptr;
 using std::tie;
 using std::unique_lock;
@@ -38,8 +41,9 @@ using std::unique_lock;
 namespace pv {
 namespace data {
 
-const int SignalBase::ColourBGAlpha = 8 * 256 / 100;
+const int SignalBase::ColorBGAlpha = 8 * 256 / 100;
 const uint64_t SignalBase::ConversionBlockSize = 4096;
+const uint32_t SignalBase::ConversionDelay = 1000;  // 1 second
 
 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
        channel_(channel),
@@ -50,6 +54,11 @@ SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_
 {
        if (channel_)
                internal_name_ = QString::fromStdString(channel_->name());
+
+       connect(&delayed_conversion_starter_, SIGNAL(timeout()),
+               this, SLOT(on_delayed_conversion_start()));
+       delayed_conversion_starter_.setSingleShot(true);
+       delayed_conversion_starter_.setInterval(ConversionDelay);
 }
 
 SignalBase::~SignalBase()
@@ -72,6 +81,14 @@ QString SignalBase::internal_name() const
        return internal_name_;
 }
 
+QString SignalBase::display_name() const
+{
+       if (name() != internal_name_)
+               return name() + " (" + internal_name_ + ")";
+       else
+               return name();
+}
+
 void SignalBase::set_name(QString name)
 {
        if (channel_)
@@ -113,24 +130,24 @@ unsigned int SignalBase::logic_bit_index() const
                return 0;
 }
 
-QColor SignalBase::colour() const
+QColor SignalBase::color() const
 {
-       return colour_;
+       return color_;
 }
 
-void SignalBase::set_colour(QColor colour)
+void SignalBase::set_color(QColor color)
 {
-       colour_ = colour;
+       color_ = color;
 
-       bgcolour_ = colour;
-       bgcolour_.setAlpha(ColourBGAlpha);
+       bgcolor_ = color;
+       bgcolor_.setAlpha(ColorBGAlpha);
 
-       colour_changed(colour);
+       color_changed(color);
 }
 
-QColor SignalBase::bgcolour() const
+QColor SignalBase::bgcolor() const
 {
-       return bgcolour_;
+       return bgcolor_;
 }
 
 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
@@ -192,6 +209,82 @@ shared_ptr<data::Logic> SignalBase::logic_data() const
        return result;
 }
 
+bool SignalBase::segment_is_complete(uint32_t segment_id) const
+{
+       bool result = true;
+
+       if (channel_type_ == AnalogChannel)
+       {
+               shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
+               auto segments = data->analog_segments();
+               try {
+                       result = segments.at(segment_id)->is_complete();
+               } catch (out_of_range&) {
+                       // Do nothing
+               }
+       }
+
+       if (channel_type_ == LogicChannel)
+       {
+               shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
+               auto segments = data->logic_segments();
+               try {
+                       result = segments.at(segment_id)->is_complete();
+               } catch (out_of_range&) {
+                       // Do nothing
+               }
+       }
+
+       return result;
+}
+
+bool SignalBase::has_samples() const
+{
+       bool result = false;
+
+       if (channel_type_ == AnalogChannel)
+       {
+               shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
+               if (data) {
+                       auto segments = data->analog_segments();
+                       if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
+                               result = true;
+               }
+       }
+
+       if (channel_type_ == LogicChannel)
+       {
+               shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
+               if (data) {
+                       auto segments = data->logic_segments();
+                       if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
+                               result = true;
+               }
+       }
+
+       return result;
+}
+
+double SignalBase::get_samplerate() const
+{
+       if (channel_type_ == AnalogChannel)
+       {
+               shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
+               if (data)
+                       return data->get_samplerate();
+       }
+
+       if (channel_type_ == LogicChannel)
+       {
+               shared_ptr<Logic> data = dynamic_pointer_cast<Logic>(data_);
+               if (data)
+                       return data->get_samplerate();
+       }
+
+       // Default samplerate is 1 Hz
+       return 1.0;
+}
+
 SignalBase::ConversionType SignalBase::get_conversion_type() const
 {
        return conversion_type_;
@@ -338,7 +431,7 @@ SignalBase::ConversionPreset SignalBase::get_current_conversion_preset() const
        if (preset != conversion_options_.end())
                return (ConversionPreset)((preset->second).toInt());
 
-       return NoPreset;
+       return DynamicPreset;
 }
 
 void SignalBase::set_conversion_preset(ConversionPreset id)
@@ -357,12 +450,12 @@ void SignalBase::save_settings(QSettings &settings) const
 {
        settings.setValue("name", name());
        settings.setValue("enabled", enabled());
-       settings.setValue("colour", colour());
+       settings.setValue("color", color());
        settings.setValue("conversion_type", (int)conversion_type_);
 
        settings.setValue("conv_options", (int)(conversion_options_.size()));
        int i = 0;
-       for (auto kvp : conversion_options_) {
+       for (auto& kvp : conversion_options_) {
                settings.setValue(QString("conv_option%1_key").arg(i), kvp.first);
                settings.setValue(QString("conv_option%1_value").arg(i), kvp.second);
                i++;
@@ -371,18 +464,30 @@ void SignalBase::save_settings(QSettings &settings) const
 
 void SignalBase::restore_settings(QSettings &settings)
 {
-       set_name(settings.value("name").toString());
-       set_enabled(settings.value("enabled").toBool());
-       set_colour(settings.value("colour").value<QColor>());
-       set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
+       if (settings.contains("name"))
+               set_name(settings.value("name").toString());
 
-       int conv_options = settings.value("conv_options").toInt();
+       if (settings.contains("enabled"))
+               set_enabled(settings.value("enabled").toBool());
+
+       if (settings.contains("color"))
+               set_color(settings.value("color").value<QColor>());
+
+       if (settings.contains("conversion_type"))
+               set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
+
+       int conv_options = 0;
+       if (settings.contains("conv_options"))
+               conv_options = settings.value("conv_options").toInt();
 
        if (conv_options)
                for (int i = 0; i < conv_options; i++) {
-                       QString key = settings.value(QString("conv_option%1_key").arg(i)).toString();
-                       QVariant value = settings.value(QString("conv_option%1_value").arg(i));
-                       conversion_options_[key] = value;
+                       const QString key_id = QString("conv_option%1_key").arg(i);
+                       const QString value_id = QString("conv_option%1_value").arg(i);
+
+                       if (settings.contains(key_id) && settings.contains(value_id))
+                               conversion_options_[settings.value(key_id).toString()] =
+                                       settings.value(value_id);
                }
 }
 
@@ -393,154 +498,221 @@ bool SignalBase::conversion_is_a2l() const
                (conversion_type_ == A2LConversionBySchmittTrigger)));
 }
 
-void SignalBase::conversion_thread_proc(QObject* segment)
+void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
+       LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample)
 {
-       // TODO Support for multiple segments is missing
+       if (end_sample > start_sample) {
+               tie(min_value_, max_value_) = asegment->get_min_max();
 
-       uint64_t start_sample, end_sample;
-       start_sample = end_sample = 0;
+               // Create sigrok::Analog instance
+               float *asamples = new float[ConversionBlockSize];
+               uint8_t *lsamples = new uint8_t[ConversionBlockSize];
 
-       do {
-               if (conversion_is_a2l()) {
+               vector<shared_ptr<sigrok::Channel> > channels;
+               channels.push_back(channel_);
+
+               vector<const sigrok::QuantityFlag*> mq_flags;
+               const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
+               const sigrok::Unit * const unit = sigrok::Unit::VOLT;
+
+               shared_ptr<sigrok::Packet> packet =
+                       Session::sr_context->create_analog_packet(channels,
+                       asamples, ConversionBlockSize, mq, unit, mq_flags);
+
+               shared_ptr<sigrok::Analog> analog =
+                       dynamic_pointer_cast<sigrok::Analog>(packet->payload());
+
+               // Convert
+               uint64_t i = start_sample;
+
+               if (conversion_type_ == A2LConversionByThreshold) {
+                       const double threshold = get_conversion_thresholds()[0];
 
-                       AnalogSegment *asegment = qobject_cast<AnalogSegment*>(segment);
+                       // Convert as many sample blocks as we can
+                       while ((end_sample - i) > ConversionBlockSize) {
+                               asegment->get_samples(i, i + ConversionBlockSize, asamples);
 
-                       const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
+                               shared_ptr<sigrok::Logic> logic =
+                                       analog->get_logic_via_threshold(threshold, lsamples);
 
-                       // Create the initial logic data segment if needed
-                       if (logic_data->segments().size() == 0) {
-                               shared_ptr<LogicSegment> lsegment =
-                                       make_shared<LogicSegment>(*logic_data.get(), 1, asegment->samplerate());
-                               logic_data->push_segment(lsegment);
+                               lsegment->append_payload(logic->data_pointer(), logic->data_length());
+                               samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
+                               i += ConversionBlockSize;
                        }
 
-                       LogicSegment *lsegment = dynamic_cast<LogicSegment*>(logic_data->segments().front().get());
+                       // Re-create sigrok::Analog and convert remaining samples
+                       packet = Session::sr_context->create_analog_packet(channels,
+                               asamples, end_sample - i, mq, unit, mq_flags);
 
-                       start_sample = lsegment->get_sample_count();
-                       end_sample = asegment->get_sample_count();
+                       analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
 
-                       if (end_sample > start_sample) {
-                               tie(min_value_, max_value_) = asegment->get_min_max();
+                       asegment->get_samples(i, end_sample, asamples);
+                       shared_ptr<sigrok::Logic> logic =
+                               analog->get_logic_via_threshold(threshold, lsamples);
+                       lsegment->append_payload(logic->data_pointer(), logic->data_length());
+                       samples_added(lsegment->segment_id(), i, end_sample);
+               }
 
-                               // Create sigrok::Analog instance
-                               float *asamples = new float[ConversionBlockSize];
-                               uint8_t *lsamples = new uint8_t[ConversionBlockSize];
+               if (conversion_type_ == A2LConversionBySchmittTrigger) {
+                       const vector<double> thresholds = get_conversion_thresholds();
+                       const double lo_thr = thresholds[0];
+                       const double hi_thr = thresholds[1];
 
-                               vector<shared_ptr<sigrok::Channel> > channels;
-                               channels.push_back(channel_);
+                       uint8_t state = 0;  // TODO Use value of logic sample n-1 instead of 0
 
-                               vector<const sigrok::QuantityFlag*> mq_flags;
-                               const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
-                               const sigrok::Unit * const unit = sigrok::Unit::VOLT;
+                       // Convert as many sample blocks as we can
+                       while ((end_sample - i) > ConversionBlockSize) {
+                               asegment->get_samples(i, i + ConversionBlockSize, asamples);
 
-                               shared_ptr<sigrok::Packet> packet =
-                                       Session::sr_context->create_analog_packet(channels,
-                                       asamples, ConversionBlockSize, mq, unit, mq_flags);
+                               shared_ptr<sigrok::Logic> logic =
+                                       analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
+                                               &state, lsamples);
 
-                               shared_ptr<sigrok::Analog> analog =
-                                       dynamic_pointer_cast<sigrok::Analog>(packet->payload());
+                               lsegment->append_payload(logic->data_pointer(), logic->data_length());
+                               samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
+                               i += ConversionBlockSize;
+                       }
 
-                               // Convert
-                               uint64_t i = start_sample;
+                       // Re-create sigrok::Analog and convert remaining samples
+                       packet = Session::sr_context->create_analog_packet(channels,
+                               asamples, end_sample - i, mq, unit, mq_flags);
 
-                               if (conversion_type_ == A2LConversionByThreshold) {
-                                       const double threshold = get_conversion_thresholds()[0];
+                       analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
 
-                                       // Convert as many sample blocks as we can
-                                       while ((end_sample - i) > ConversionBlockSize) {
-                                               asegment->get_samples(i, i + ConversionBlockSize, asamples);
+                       asegment->get_samples(i, end_sample, asamples);
+                       shared_ptr<sigrok::Logic> logic =
+                               analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
+                                       &state, lsamples);
+                       lsegment->append_payload(logic->data_pointer(), logic->data_length());
+                       samples_added(lsegment->segment_id(), i, end_sample);
+               }
 
-                                               shared_ptr<sigrok::Logic> logic =
-                                                       analog->get_logic_via_threshold(threshold, lsamples);
+               // If acquisition is ongoing, start-/endsample may have changed
+               end_sample = asegment->get_sample_count();
 
-                                               lsegment->append_payload(logic->data_pointer(), logic->data_length());
+               delete[] lsamples;
+               delete[] asamples;
+       }
+}
 
-                                               samples_added(lsegment, i, i + ConversionBlockSize);
-                                               i += ConversionBlockSize;
-                                       }
+void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
+{
+       uint64_t start_sample, end_sample, old_end_sample;
+       start_sample = end_sample = 0;
+       bool complete_state, old_complete_state;
+
+       start_sample = lsegment->get_sample_count();
+       end_sample = asegment->get_sample_count();
+       complete_state = asegment->is_complete();
+
+       // Don't do anything if the segment is still being filled and the sample count is too small
+       if ((!complete_state) && (end_sample - start_sample < ConversionBlockSize))
+               return;
 
-                                       // Re-create sigrok::Analog and convert remaining samples
-                                       packet = Session::sr_context->create_analog_packet(channels,
-                                               asamples, end_sample - i, mq, unit, mq_flags);
+       do {
+               convert_single_segment_range(asegment, lsegment, start_sample, end_sample);
 
-                                       analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
+               old_end_sample = end_sample;
+               old_complete_state = complete_state;
 
-                                       asegment->get_samples(i, end_sample, asamples);
-                                       shared_ptr<sigrok::Logic> logic =
-                                               analog->get_logic_via_threshold(threshold, lsamples);
-                                       lsegment->append_payload(logic->data_pointer(), logic->data_length());
-                                       samples_added(lsegment, i, end_sample);
-                               }
+               start_sample = lsegment->get_sample_count();
+               end_sample = asegment->get_sample_count();
+               complete_state = asegment->is_complete();
 
-                               if (conversion_type_ == A2LConversionBySchmittTrigger) {
-                                       const vector<double> thresholds = get_conversion_thresholds();
-                                       const double lo_thr = thresholds[0];
-                                       const double hi_thr = thresholds[1];
+               // If the segment has been incomplete when we were called and has been
+               // completed in the meanwhile, we convert the remaining samples as well.
+               // Also, if a sufficient number of samples was added in the meanwhile,
+               // we do another round of sample conversion.
+       } while ((complete_state != old_complete_state) ||
+               (end_sample - old_end_sample >= ConversionBlockSize));
+}
 
-                                       uint8_t state = 0;  // TODO Use value of logic sample n-1 instead of 0
+void SignalBase::conversion_thread_proc()
+{
+       shared_ptr<Analog> analog_data;
 
-                                       // Convert as many sample blocks as we can
-                                       while ((end_sample - i) > ConversionBlockSize) {
-                                               asegment->get_samples(i, i + ConversionBlockSize, asamples);
+       if (conversion_is_a2l()) {
+               analog_data = dynamic_pointer_cast<Analog>(data_);
+
+               if (analog_data->analog_segments().size() == 0) {
+                       unique_lock<mutex> input_lock(conversion_input_mutex_);
+                       conversion_input_cond_.wait(input_lock);
+               }
 
-                                               shared_ptr<sigrok::Logic> logic =
-                                                       analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
-                                                               &state, lsamples);
+       } else
+               // Currently, we only handle A2L conversions
+               return;
 
-                                               lsegment->append_payload(logic->data_pointer(), logic->data_length());
+       // If we had to wait for input data, we may have been notified to terminate
+       if (conversion_interrupt_)
+               return;
 
-                                               samples_added(lsegment, i, i + ConversionBlockSize);
-                                               i += ConversionBlockSize;
-                                       }
+       uint32_t segment_id = 0;
 
-                                       // Re-create sigrok::Analog and convert remaining samples
-                                       packet = Session::sr_context->create_analog_packet(channels,
-                                               asamples, end_sample - i, mq, unit, mq_flags);
+       AnalogSegment *asegment = analog_data->analog_segments().front().get();
+       assert(asegment);
 
-                                       analog = dynamic_pointer_cast<sigrok::Analog>(packet->payload());
+       const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
+       assert(logic_data);
 
-                                       asegment->get_samples(i, end_sample, asamples);
-                                       shared_ptr<sigrok::Logic> logic =
-                                               analog->get_logic_via_schmitt_trigger(lo_thr, hi_thr,
-                                                       &state, lsamples);
-                                       lsegment->append_payload(logic->data_pointer(), logic->data_length());
-                                       samples_added(lsegment, i, end_sample);
-                               }
+       // Create the initial logic data segment if needed
+       if (logic_data->logic_segments().size() == 0) {
+               shared_ptr<LogicSegment> new_segment =
+                       make_shared<LogicSegment>(*logic_data.get(), 0, 1, asegment->samplerate());
+               logic_data->push_segment(new_segment);
+       }
 
-                               // If acquisition is ongoing, start-/endsample may have changed
-                               end_sample = asegment->get_sample_count();
+       LogicSegment *lsegment = logic_data->logic_segments().front().get();
+       assert(lsegment);
 
-                               delete[] lsamples;
-                               delete[] asamples;
+       do {
+               convert_single_segment(asegment, lsegment);
+
+               // Only advance to next segment if the current input segment is complete
+               if (asegment->is_complete() &&
+                       analog_data->analog_segments().size() > logic_data->logic_segments().size()) {
+                       // There are more segments to process
+                       segment_id++;
+
+                       try {
+                               asegment = analog_data->analog_segments().at(segment_id).get();
+                       } catch (out_of_range&) {
+                               qDebug() << "Conversion error for" << name() << ": no analog segment" \
+                                       << segment_id << ", segments size is" << analog_data->analog_segments().size();
+                               return;
                        }
-               }
 
-               if (!conversion_interrupt_ && (start_sample == end_sample)) {
-                       unique_lock<mutex> input_lock(conversion_input_mutex_);
-                       conversion_input_cond_.wait(input_lock);
+                       shared_ptr<LogicSegment> new_segment = make_shared<LogicSegment>(
+                               *logic_data.get(), segment_id, 1, asegment->samplerate());
+                       logic_data->push_segment(new_segment);
+
+                       lsegment = logic_data->logic_segments().back().get();
+               } else {
+                       // No more samples/segments to process, wait for data or interrupt
+                       if (!conversion_interrupt_) {
+                               unique_lock<mutex> input_lock(conversion_input_mutex_);
+                               conversion_input_cond_.wait(input_lock);
+                       }
                }
        } while (!conversion_interrupt_);
 }
 
-void SignalBase::start_conversion()
+void SignalBase::start_conversion(bool delayed_start)
 {
+       if (delayed_start) {
+               delayed_conversion_starter_.start();
+               return;
+       }
+
        stop_conversion();
 
        if (converted_data_)
                converted_data_->clear();
+       samples_cleared();
 
-       if (conversion_is_a2l()) {
-               shared_ptr<Analog> analog_data = dynamic_pointer_cast<Analog>(data_);
-
-               if (analog_data->analog_segments().size() > 0) {
-                       // TODO Support for multiple segments is missing
-                       AnalogSegment *asegment = analog_data->analog_segments().front().get();
-
-                       conversion_interrupt_ = false;
-                       conversion_thread_ = std::thread(
-                               &SignalBase::conversion_thread_proc, this, asegment);
-               }
-       }
+       conversion_interrupt_ = false;
+       conversion_thread_ = std::thread(
+               &SignalBase::conversion_thread_proc, this);
 }
 
 void SignalBase::stop_conversion()
@@ -568,23 +740,24 @@ void SignalBase::on_samples_added(QObject* segment, uint64_t start_sample,
                        // Notify the conversion thread since it's running
                        conversion_input_cond_.notify_one();
                } else {
-                       // Start the conversion thread
-                       start_conversion();
+                       // Start the conversion thread unless the delay timer is running
+                       if (!delayed_conversion_starter_.isActive())
+                               start_conversion();
                }
        }
 
-       samples_added(segment, start_sample, end_sample);
+       data::Segment* s = qobject_cast<data::Segment*>(segment);
+       samples_added(s->segment_id(), start_sample, end_sample);
 }
 
 void SignalBase::on_min_max_changed(float min, float max)
 {
-       (void)min;
-       (void)max;
-
        // Restart conversion if one is enabled and uses a calculated threshold
        if ((conversion_type_ != NoConversion) &&
                (get_current_conversion_preset() == DynamicPreset))
-               start_conversion();
+               start_conversion(true);
+
+       min_max_changed(min, max);
 }
 
 void SignalBase::on_capture_state_changed(int state)
@@ -596,5 +769,10 @@ void SignalBase::on_capture_state_changed(int state)
        }
 }
 
+void SignalBase::on_delayed_conversion_start()
+{
+       start_conversion();
+}
+
 } // namespace data
 } // namespace pv