]> sigrok.org Git - pulseview.git/blobdiff - pv/data/signalbase.cpp
Session: Fix issue #67 by improving error handling
[pulseview.git] / pv / data / signalbase.cpp
index 54063b1d236bc1eff9a8ca1e44ad76aa95409cae..97f705084e91fc654c85ab7ce07cbfec64a3df50 100644 (file)
@@ -28,8 +28,9 @@
 
 #include <QDebug>
 
-#include <pv/binding/decoder.hpp>
+#include <extdef.h>
 #include <pv/session.hpp>
+#include <pv/binding/decoder.hpp>
 
 using std::dynamic_pointer_cast;
 using std::make_shared;
@@ -41,24 +42,107 @@ using std::unique_lock;
 namespace pv {
 namespace data {
 
-const int SignalBase::ColourBGAlpha = 8 * 256 / 100;
+const QColor SignalBase::AnalogSignalColors[8] =
+{
+       QColor(0xC4, 0xA0, 0x00),       // Yellow   HSV:  49 / 100 / 77
+       QColor(0x87, 0x20, 0x7A),       // Magenta  HSV: 308 /  70 / 53
+       QColor(0x20, 0x4A, 0x87),       // Blue     HSV: 216 /  76 / 53
+       QColor(0x4E, 0x9A, 0x06),       // Green    HSV:  91 /  96 / 60
+       QColor(0xBF, 0x6E, 0x00),       // Orange   HSV:  35 / 100 / 75
+       QColor(0x5E, 0x20, 0x80),       // Purple   HSV: 280 /  75 / 50
+       QColor(0x20, 0x80, 0x7A),       // Turqoise HSV: 177 /  75 / 50
+       QColor(0x80, 0x20, 0x24)        // Red      HSV: 358 /  75 / 50
+};
+
+const QColor SignalBase::LogicSignalColors[10] =
+{
+       QColor(0x16, 0x19, 0x1A),       // Black
+       QColor(0x8F, 0x52, 0x02),       // Brown
+       QColor(0xCC, 0x00, 0x00),       // Red
+       QColor(0xF5, 0x79, 0x00),       // Orange
+       QColor(0xED, 0xD4, 0x00),       // Yellow
+       QColor(0x73, 0xD2, 0x16),       // Green
+       QColor(0x34, 0x65, 0xA4),       // Blue
+       QColor(0x75, 0x50, 0x7B),       // Violet
+       QColor(0x88, 0x8A, 0x85),       // Grey
+       QColor(0xEE, 0xEE, 0xEC),       // White
+};
+
+
+const int SignalBase::ColorBGAlpha = 8 * 256 / 100;
 const uint64_t SignalBase::ConversionBlockSize = 4096;
 const uint32_t SignalBase::ConversionDelay = 1000;  // 1 second
 
+
+SignalGroup::SignalGroup(const QString& name)
+{
+       name_ = name;
+}
+
+void SignalGroup::append_signal(shared_ptr<SignalBase> signal)
+{
+       if (!signal)
+               return;
+
+       signals_.push_back(signal);
+       signal->set_group(this);
+}
+
+void SignalGroup::remove_signal(shared_ptr<SignalBase> signal)
+{
+       if (!signal)
+               return;
+
+       signals_.erase(std::remove_if(signals_.begin(), signals_.end(),
+               [&](shared_ptr<SignalBase> s) { return s == signal; }),
+               signals_.end());
+}
+
+deque<shared_ptr<SignalBase>> SignalGroup::signals() const
+{
+       return signals_;
+}
+
+void SignalGroup::clear()
+{
+       for (shared_ptr<SignalBase> sb : signals_)
+               sb->set_group(nullptr);
+
+       signals_.clear();
+}
+
+const QString SignalGroup::name() const
+{
+       return name_;
+}
+
+
 SignalBase::SignalBase(shared_ptr<sigrok::Channel> channel, ChannelType channel_type) :
        channel_(channel),
        channel_type_(channel_type),
+       group_(nullptr),
        conversion_type_(NoConversion),
        min_value_(0),
-       max_value_(0)
+       max_value_(0),
+       index_(0),
+       error_message_("")
 {
-       if (channel_)
-               internal_name_ = QString::fromStdString(channel_->name());
+       if (channel_) {
+               set_internal_name(QString::fromStdString(channel_->name()));
+               set_index(channel_->index());
+       }
 
        connect(&delayed_conversion_starter_, SIGNAL(timeout()),
                this, SLOT(on_delayed_conversion_start()));
        delayed_conversion_starter_.setSingleShot(true);
        delayed_conversion_starter_.setInterval(ConversionDelay);
+
+       // Only logic and analog SR channels can have their colors auto-set
+       // because for them, we have an index that can be used
+       if (channel_type == LogicChannel)
+               set_color(LogicSignalColors[index() % countof(LogicSignalColors)]);
+       else if (channel_type == AnalogChannel)
+               set_color(AnalogSignalColors[index() % countof(AnalogSignalColors)]);
 }
 
 SignalBase::~SignalBase()
@@ -71,32 +155,10 @@ shared_ptr<sigrok::Channel> SignalBase::channel() const
        return channel_;
 }
 
-QString SignalBase::name() const
-{
-       return (channel_) ? QString::fromStdString(channel_->name()) : name_;
-}
-
-QString SignalBase::internal_name() const
+bool SignalBase::is_generated() 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_)
-               channel_->set_name(name.toUtf8().constData());
-
-       name_ = name;
-
-       name_changed(name);
+       // Only signals associated with a device have a corresponding sigrok channel
+       return channel_ == nullptr;
 }
 
 bool SignalBase::enabled() const
@@ -119,35 +181,91 @@ SignalBase::ChannelType SignalBase::type() const
 
 unsigned int SignalBase::index() const
 {
-       return (channel_) ? channel_->index() : 0;
+       return index_;
+}
+
+void SignalBase::set_index(unsigned int index)
+{
+       index_ = index;
 }
 
 unsigned int SignalBase::logic_bit_index() const
 {
        if (channel_type_ == LogicChannel)
-               return channel_->index();
+               return index_;
        else
                return 0;
 }
 
-QColor SignalBase::colour() const
+void SignalBase::set_group(SignalGroup* group)
+{
+       group_ = group;
+}
+
+SignalGroup* SignalBase::group() const
+{
+       return group_;
+}
+
+QString SignalBase::name() const
+{
+       return (channel_) ? QString::fromStdString(channel_->name()) : name_;
+}
+
+QString SignalBase::internal_name() const
+{
+       return internal_name_;
+}
+
+void SignalBase::set_internal_name(QString internal_name)
+{
+       internal_name_ = internal_name;
+
+       // Use this name also for the QObject instance
+       setObjectName(internal_name);
+}
+
+QString SignalBase::display_name() const
+{
+       if ((name() != internal_name_) && (!internal_name_.isEmpty()))
+               return name() + " (" + internal_name_ + ")";
+       else
+               return name();
+}
+
+void SignalBase::set_name(QString name)
 {
-       return colour_;
+       if (channel_)
+               channel_->set_name(name.toUtf8().constData());
+
+       name_ = name;
+
+       name_changed(name);
 }
 
-void SignalBase::set_colour(QColor colour)
+QColor SignalBase::color() const
 {
-       colour_ = colour;
+       return color_;
+}
+
+void SignalBase::set_color(QColor color)
+{
+       color_ = color;
+
+       bgcolor_ = color;
+       bgcolor_.setAlpha(ColorBGAlpha);
 
-       bgcolour_ = colour;
-       bgcolour_.setAlpha(ColourBGAlpha);
+       color_changed(color);
+}
 
-       colour_changed(colour);
+QColor SignalBase::bgcolor() const
+{
+       return bgcolor_;
 }
 
-QColor SignalBase::bgcolour() const
+QString SignalBase::get_error_message() const
 {
-       return bgcolour_;
+       return error_message_;
 }
 
 void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
@@ -155,16 +273,13 @@ void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
        if (data_) {
                disconnect(data.get(), SIGNAL(samples_cleared()),
                        this, SLOT(on_samples_cleared()));
-               disconnect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
-                       this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
-
-               if (channel_type_ == AnalogChannel) {
-                       shared_ptr<Analog> analog = analog_data();
-                       assert(analog);
+               disconnect(data.get(), SIGNAL(samples_added(shared_ptr<Segment>, uint64_t, uint64_t)),
+                       this, SLOT(on_samples_added(shared_ptr<Segment>, uint64_t, uint64_t)));
 
+               shared_ptr<Analog> analog = analog_data();
+               if (analog)
                        disconnect(analog.get(), SIGNAL(min_max_changed(float, float)),
                                this, SLOT(on_min_max_changed(float, float)));
-               }
        }
 
        data_ = data;
@@ -172,72 +287,120 @@ void SignalBase::set_data(shared_ptr<pv::data::SignalData> data)
        if (data_) {
                connect(data.get(), SIGNAL(samples_cleared()),
                        this, SLOT(on_samples_cleared()));
-               connect(data.get(), SIGNAL(samples_added(QObject*, uint64_t, uint64_t)),
-                       this, SLOT(on_samples_added(QObject*, uint64_t, uint64_t)));
-
-               if (channel_type_ == AnalogChannel) {
-                       shared_ptr<Analog> analog = analog_data();
-                       assert(analog);
+               connect(data.get(), SIGNAL(samples_added(SharedPtrToSegment, uint64_t, uint64_t)),
+                       this, SLOT(on_samples_added(SharedPtrToSegment, uint64_t, uint64_t)));
 
+               shared_ptr<Analog> analog = analog_data();
+               if (analog)
                        connect(analog.get(), SIGNAL(min_max_changed(float, float)),
                                this, SLOT(on_min_max_changed(float, float)));
-               }
        }
 }
 
-shared_ptr<data::Analog> SignalBase::analog_data() const
+void SignalBase::clear_sample_data()
 {
-       shared_ptr<Analog> result = nullptr;
+       if (analog_data())
+               analog_data()->clear();
 
-       if (channel_type_ == AnalogChannel)
-               result = dynamic_pointer_cast<Analog>(data_);
+       if (logic_data())
+               logic_data()->clear();
+}
 
-       return result;
+shared_ptr<data::Analog> SignalBase::analog_data() const
+{
+       if (!data_)
+               return nullptr;
+
+       return dynamic_pointer_cast<Analog>(data_);
 }
 
 shared_ptr<data::Logic> SignalBase::logic_data() const
 {
-       shared_ptr<Logic> result = nullptr;
+       if (!data_)
+               return nullptr;
 
-       if (channel_type_ == LogicChannel)
-               result = dynamic_pointer_cast<Logic>(data_);
+       shared_ptr<Logic> result;
 
        if (((conversion_type_ == A2LConversionByThreshold) ||
                (conversion_type_ == A2LConversionBySchmittTrigger)))
                result = dynamic_pointer_cast<Logic>(converted_data_);
+       else
+               result = dynamic_pointer_cast<Logic>(data_);
 
        return result;
 }
 
+shared_ptr<pv::data::SignalData> SignalBase::data() const
+{
+       return data_;
+}
+
 bool SignalBase::segment_is_complete(uint32_t segment_id) const
 {
        bool result = true;
 
-       if (channel_type_ == AnalogChannel)
+       shared_ptr<Analog> adata = analog_data();
+       if (adata)
        {
-               shared_ptr<Analog> data = dynamic_pointer_cast<Analog>(data_);
-               auto segments = data->analog_segments();
+               auto segments = adata->analog_segments();
                try {
                        result = segments.at(segment_id)->is_complete();
-               } catch (out_of_range) {
+               } catch (out_of_range&) {
                        // Do nothing
                }
+       } else {
+               shared_ptr<Logic> ldata = logic_data();
+               if (ldata) {
+                       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
+                       }
+               }
        }
 
-       if (channel_type_ == LogicChannel)
+       return result;
+}
+
+bool SignalBase::has_samples() const
+{
+       bool result = false;
+
+       shared_ptr<Analog> adata = analog_data();
+       if (adata)
        {
-               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
+               auto segments = adata->analog_segments();
+               if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
+                       result = true;
+       } else {
+               shared_ptr<Logic> ldata = logic_data();
+               if (ldata) {
+                       auto segments = ldata->logic_segments();
+                       if ((segments.size() > 0) && (segments.front()->get_sample_count() > 0))
+                               result = true;
                }
        }
 
        return result;
 }
 
+double SignalBase::get_samplerate() const
+{
+       shared_ptr<Analog> adata = analog_data();
+       if (adata)
+               return adata->get_samplerate();
+       else {
+               shared_ptr<Logic> ldata = logic_data();
+               if (ldata)
+                       return ldata->get_samplerate();
+       }
+
+       // Default samplerate is 1 Hz
+       return 1.0;
+}
+
 SignalBase::ConversionType SignalBase::get_conversion_type() const
 {
        return conversion_type_;
@@ -403,12 +566,12 @@ void SignalBase::save_settings(QSettings &settings) const
 {
        settings.setValue("name", name());
        settings.setValue("enabled", enabled());
-       settings.setValue("colour", colour());
+       settings.setValue("color", color().rgba());
        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++;
@@ -417,40 +580,70 @@ 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());
+
+       if (settings.contains("enabled"))
+               set_enabled(settings.value("enabled").toBool());
+
+       if (settings.contains("color")) {
+               QVariant value = settings.value("color");
+
+               // Workaround for Qt QColor serialization bug on OSX
+#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
+               bool is_qcolor = (QMetaType::Type)(value.typeId()) == QMetaType::QColor;
+#else
+               bool is_qcolor = (QMetaType::Type)(value.type()) == QMetaType::QColor;
+#endif
+               if (is_qcolor)
+                       set_color(value.value<QColor>());
+               else
+                       set_color(QColor::fromRgba(value.value<uint32_t>()));
+
+               // A color with an alpha value of 0 makes the signal marker invisible
+               if (color() == QColor(0, 0, 0, 0))
+                       set_color(Qt::gray);
+       }
+
+       if (settings.contains("conversion_type"))
+               set_conversion_type((ConversionType)settings.value("conversion_type").toInt());
 
-       int conv_options = settings.value("conv_options").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);
                }
 }
 
 bool SignalBase::conversion_is_a2l() const
 {
-       return ((channel_type_ == AnalogChannel) &&
-               ((conversion_type_ == A2LConversionByThreshold) ||
+       return (((conversion_type_ == A2LConversionByThreshold) ||
                (conversion_type_ == A2LConversionBySchmittTrigger)));
 }
 
-void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
-       LogicSegment *lsegment, uint64_t start_sample, uint64_t end_sample)
+void SignalBase::convert_single_segment_range(shared_ptr<AnalogSegment> asegment,
+       shared_ptr<LogicSegment> lsegment, uint64_t start_sample, uint64_t end_sample)
 {
        if (end_sample > start_sample) {
                tie(min_value_, max_value_) = asegment->get_min_max();
 
                // Create sigrok::Analog instance
                float *asamples = new float[ConversionBlockSize];
+               assert(asamples);
                uint8_t *lsamples = new uint8_t[ConversionBlockSize];
+               assert(lsamples);
 
                vector<shared_ptr<sigrok::Channel> > channels;
-               channels.push_back(channel_);
+               if (channel_)
+                       channels.push_back(channel_);
 
                vector<const sigrok::QuantityFlag*> mq_flags;
                const sigrok::Quantity * const mq = sigrok::Quantity::VOLTAGE;
@@ -511,6 +704,7 @@ void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
 
                                lsegment->append_payload(logic->data_pointer(), logic->data_length());
                                samples_added(lsegment->segment_id(), i, i + ConversionBlockSize);
+
                                i += ConversionBlockSize;
                        }
 
@@ -534,9 +728,12 @@ void SignalBase::convert_single_segment_range(AnalogSegment *asegment,
                delete[] lsamples;
                delete[] asamples;
        }
+
+       samples_added(lsegment->segment_id(), start_sample, end_sample);
 }
 
-void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *lsegment)
+void SignalBase::convert_single_segment(shared_ptr<AnalogSegment> asegment,
+       shared_ptr<LogicSegment> lsegment)
 {
        uint64_t start_sample, end_sample, old_end_sample;
        start_sample = end_sample = 0;
@@ -566,6 +763,9 @@ void SignalBase::convert_single_segment(AnalogSegment *asegment, LogicSegment *l
                // we do another round of sample conversion.
        } while ((complete_state != old_complete_state) ||
                (end_sample - old_end_sample >= ConversionBlockSize));
+
+       if (complete_state)
+               lsegment->set_complete();
 }
 
 void SignalBase::conversion_thread_proc()
@@ -590,8 +790,9 @@ void SignalBase::conversion_thread_proc()
 
        uint32_t segment_id = 0;
 
-       AnalogSegment *asegment = analog_data->analog_segments().front().get();
+       shared_ptr<AnalogSegment> asegment = analog_data->analog_segments().front();
        assert(asegment);
+       connect(asegment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
 
        const shared_ptr<Logic> logic_data = dynamic_pointer_cast<Logic>(converted_data_);
        assert(logic_data);
@@ -603,7 +804,7 @@ void SignalBase::conversion_thread_proc()
                logic_data->push_segment(new_segment);
        }
 
-       LogicSegment *lsegment = logic_data->logic_segments().front().get();
+       shared_ptr<LogicSegment> lsegment = logic_data->logic_segments().front();
        assert(lsegment);
 
        do {
@@ -612,12 +813,17 @@ void SignalBase::conversion_thread_proc()
                // 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()) {
+
+                       disconnect(asegment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
+
                        // There are more segments to process
                        segment_id++;
 
                        try {
-                               asegment = analog_data->analog_segments().at(segment_id).get();
-                       } catch (out_of_range) {
+                               asegment = analog_data->analog_segments().at(segment_id);
+                               disconnect(asegment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
+                               connect(asegment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
+                       } catch (out_of_range&) {
                                qDebug() << "Conversion error for" << name() << ": no analog segment" \
                                        << segment_id << ", segments size is" << analog_data->analog_segments().size();
                                return;
@@ -627,7 +833,7 @@ void SignalBase::conversion_thread_proc()
                                *logic_data.get(), segment_id, 1, asegment->samplerate());
                        logic_data->push_segment(new_segment);
 
-                       lsegment = logic_data->logic_segments().back().get();
+                       lsegment = logic_data->logic_segments().back();
                } else {
                        // No more samples/segments to process, wait for data or interrupt
                        if (!conversion_interrupt_) {
@@ -636,6 +842,8 @@ void SignalBase::conversion_thread_proc()
                        }
                }
        } while (!conversion_interrupt_);
+
+       disconnect(asegment.get(), SIGNAL(completed()), this, SLOT(on_input_segment_completed()));
 }
 
 void SignalBase::start_conversion(bool delayed_start)
@@ -647,13 +855,22 @@ void SignalBase::start_conversion(bool delayed_start)
 
        stop_conversion();
 
-       if (converted_data_)
+       if (converted_data_ && (converted_data_->get_segment_count() > 0)) {
                converted_data_->clear();
-       samples_cleared();
+               samples_cleared();
+       }
 
        conversion_interrupt_ = false;
-       conversion_thread_ = std::thread(
-               &SignalBase::conversion_thread_proc, this);
+       conversion_thread_ = std::thread(&SignalBase::conversion_thread_proc, this);
+}
+
+void SignalBase::set_error_message(QString msg)
+{
+       error_message_ = msg;
+       // TODO Emulate noquote()
+       qDebug().nospace() << name() << ": " << msg;
+
+       error_message_changed(msg);
 }
 
 void SignalBase::stop_conversion()
@@ -667,13 +884,13 @@ void SignalBase::stop_conversion()
 
 void SignalBase::on_samples_cleared()
 {
-       if (converted_data_)
+       if (converted_data_ && (converted_data_->get_segment_count() > 0)) {
                converted_data_->clear();
-
-       samples_cleared();
+               samples_cleared();
+       }
 }
 
-void SignalBase::on_samples_added(QObject* segment, uint64_t start_sample,
+void SignalBase::on_samples_added(SharedPtrToSegment segment, uint64_t start_sample,
        uint64_t end_sample)
 {
        if (conversion_type_ != NoConversion) {
@@ -687,8 +904,16 @@ void SignalBase::on_samples_added(QObject* segment, uint64_t start_sample,
                }
        }
 
-       data::Segment* s = qobject_cast<data::Segment*>(segment);
-       samples_added(s->segment_id(), start_sample, end_sample);
+       samples_added(segment->segment_id(), start_sample, end_sample);
+}
+
+void SignalBase::on_input_segment_completed()
+{
+       if (conversion_type_ != NoConversion)
+               if (conversion_thread_.joinable()) {
+                       // Notify the conversion thread since it's running
+                       conversion_input_cond_.notify_one();
+               }
 }
 
 void SignalBase::on_min_max_changed(float min, float max)