]> sigrok.org Git - pulseview.git/blobdiff - pv/session.cpp
Use SignalBase instead of LogicSignal for decoders
[pulseview.git] / pv / session.cpp
index e187a4d35245aecefe25b344433346595664c1f4..99dca2157e96641ed0fdbf7dd3100749dd35f963 100644 (file)
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
+#ifdef _WIN32
+// Windows: Avoid boost/thread namespace pollution (which includes windows.h).
+#define NOGDI
+#define NORESOURCE
+#endif
+#include <boost/thread/locks.hpp>
+#include <boost/thread/shared_mutex.hpp>
+
 #ifdef ENABLE_DECODE
 #include <libsigrokdecode/libsigrokdecode.h>
 #endif
@@ -31,6 +39,7 @@
 #include "data/decoderstack.hpp"
 #include "data/logic.hpp"
 #include "data/logicsegment.hpp"
+#include "data/signalbase.hpp"
 #include "data/decode/decoder.hpp"
 
 #include "devices/hardwaredevice.hpp"
@@ -90,7 +99,6 @@ Session::Session(DeviceManager &device_manager) :
        capture_state_(Stopped),
        cur_samplerate_(0)
 {
-       set_default_device();
 }
 
 Session::~Session()
@@ -128,16 +136,47 @@ void Session::set_device(shared_ptr<devices::Device> device)
        // Ensure we are not capturing before setting the device
        stop_capture();
 
+       if (device_)
+               device_->close();
+
+       device_.reset();
+
+       // Remove all stored data
+       signals_.clear();
+       {
+               shared_lock<shared_mutex> lock(signals_mutex_);
+               for (const shared_ptr<data::SignalData> d : all_signal_data_)
+                       d->clear();
+       }
+       all_signal_data_.clear();
+       cur_logic_segment_.reset();
+
+       for (auto entry : cur_analog_segments_) {
+               shared_ptr<sigrok::Channel>(entry.first).reset();
+               shared_ptr<data::AnalogSegment>(entry.second).reset();
+       }
+
+       logic_data_.reset();
+       decode_traces_.clear();
+
+       signals_changed();
+
        device_ = std::move(device);
-       device_->create();
+
+       try {
+               device_->open();
+       } catch (const QString &e) {
+               device_.reset();
+               device_selected();
+               throw;
+       }
+
        device_->session()->add_datafeed_callback([=]
                (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
                        data_feed_in(device, packet);
                });
-       update_signals();
-
-       decode_traces_.clear();
 
+       update_signals();
        device_selected();
 }
 
@@ -165,25 +204,35 @@ Session::capture_state Session::get_capture_state() const
 
 void Session::start_capture(function<void (const QString)> error_handler)
 {
+       if (!device_) {
+               error_handler(tr("No active device set, can't start acquisition."));
+               return;
+       }
+
        stop_capture();
 
        // Check that at least one channel is enabled
-       assert(device_);
-       const std::shared_ptr<sigrok::Device> device = device_->device();
-       assert(device);
-       auto channels = device->channels();
-       bool enabled = std::any_of(channels.begin(), channels.end(),
-               [](shared_ptr<Channel> channel) { return channel->enabled(); });
+       const shared_ptr<sigrok::Device> sr_dev = device_->device();
+       if (sr_dev) {
+               const auto channels = sr_dev->channels();
+               if (!std::any_of(channels.begin(), channels.end(),
+                       [](shared_ptr<Channel> channel) {
+                               return channel->enabled(); })) {
+                       error_handler(tr("No channels enabled."));
+                       return;
+               }
+       }
 
-       if (!enabled) {
-               error_handler(tr("No channels enabled."));
-               return;
+       // Clear signal data
+       {
+               shared_lock<shared_mutex> lock(signals_mutex_);
+               for (const shared_ptr<data::SignalData> d : all_signal_data_)
+                       d->clear();
        }
 
        // Begin the session
        sampling_thread_ = std::thread(
-               &Session::sample_thread_proc, this, device_,
-                       error_handler);
+               &Session::sample_thread_proc, this, error_handler);
 }
 
 void Session::stop_capture()
@@ -196,36 +245,40 @@ void Session::stop_capture()
                sampling_thread_.join();
 }
 
-set< shared_ptr<data::SignalData> > Session::get_data() const
+double Session::get_samplerate() const
 {
-       shared_lock<shared_mutex> lock(signals_mutex_);
-       set< shared_ptr<data::SignalData> > data;
-       for (const shared_ptr<view::Signal> sig : signals_) {
-               assert(sig);
-               data.insert(sig->data());
-       }
+       double samplerate = 0.0;
 
-       return data;
-}
+       {
+               shared_lock<shared_mutex> lock(signals_mutex_);
+               for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
+                       assert(d);
+                       const vector< shared_ptr<pv::data::Segment> > segments =
+                               d->segments();
+                       for (const shared_ptr<pv::data::Segment> &s : segments)
+                               samplerate = std::max(samplerate, s->samplerate());
+               }
+       }
+       // If there is no sample rate given we use samples as unit
+       if (samplerate == 0.0)
+               samplerate = 1.0;
 
-boost::shared_mutex& Session::signals_mutex() const
-{
-       return signals_mutex_;
+       return samplerate;
 }
 
-const unordered_set< shared_ptr<view::Signal> >& Session::signals() const
+const unordered_set< shared_ptr<view::Signal> > Session::signals() const
 {
+       shared_lock<shared_mutex> lock(signals_mutex_);
        return signals_;
 }
 
 #ifdef ENABLE_DECODE
 bool Session::add_decoder(srd_decoder *const dec)
 {
-       map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
+       map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
        shared_ptr<data::DecoderStack> decoder_stack;
 
-       try
-       {
+       try {
                lock_guard<boost::shared_mutex> lock(signals_mutex_);
 
                // Create the decoder
@@ -234,21 +287,19 @@ bool Session::add_decoder(srd_decoder *const dec)
 
                // Make a list of all the channels
                std::vector<const srd_channel*> all_channels;
-               for(const GSList *i = dec->channels; i; i = i->next)
+               for (const GSList *i = dec->channels; i; i = i->next)
                        all_channels.push_back((const srd_channel*)i->data);
-               for(const GSList *i = dec->opt_channels; i; i = i->next)
+               for (const GSList *i = dec->opt_channels; i; i = i->next)
                        all_channels.push_back((const srd_channel*)i->data);
 
                // Auto select the initial channels
                for (const srd_channel *pdch : all_channels)
-                       for (shared_ptr<view::Signal> s : signals_)
-                       {
-                               shared_ptr<view::LogicSignal> l =
-                                       dynamic_pointer_cast<view::LogicSignal>(s);
-                               if (l && QString::fromUtf8(pdch->name).
-                                       toLower().contains(
-                                       l->name().toLower()))
-                                       channels[pdch] = l;
+                       for (shared_ptr<data::SignalBase> b : signalbases_) {
+                               if (b->type() == ChannelType::LOGIC) {
+                                       if (QString::fromUtf8(pdch->name).toLower().
+                                               contains(b->name().toLower()))
+                                               channels[pdch] = b;
+                               }
                        }
 
                assert(decoder_stack);
@@ -257,13 +308,14 @@ bool Session::add_decoder(srd_decoder *const dec)
                decoder_stack->stack().front()->set_channels(channels);
 
                // Create the decode signal
+               shared_ptr<data::SignalBase> signalbase =
+                       shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
+
                shared_ptr<view::DecodeTrace> d(
-                       new view::DecodeTrace(*this, decoder_stack,
+                       new view::DecodeTrace(*this, signalbase, decoder_stack,
                                decode_traces_.size()));
                decode_traces_.push_back(d);
-       }
-       catch(std::runtime_error e)
-       {
+       } catch (std::runtime_error e) {
                return false;
        }
 
@@ -284,8 +336,7 @@ vector< shared_ptr<view::DecodeTrace> > Session::get_decode_signals() const
 void Session::remove_decode_signal(view::DecodeTrace *signal)
 {
        for (auto i = decode_traces_.begin(); i != decode_traces_.end(); i++)
-               if ((*i).get() == signal)
-               {
+               if ((*i).get() == signal) {
                        decode_traces_.erase(i);
                        signals_changed();
                        return;
@@ -295,17 +346,27 @@ void Session::remove_decode_signal(view::DecodeTrace *signal)
 
 void Session::set_capture_state(capture_state state)
 {
-       lock_guard<mutex> lock(sampling_mutex_);
-       const bool changed = capture_state_ != state;
-       capture_state_ = state;
-       if(changed)
+       bool changed;
+
+       {
+               lock_guard<mutex> lock(sampling_mutex_);
+               changed = capture_state_ != state;
+               capture_state_ = state;
+       }
+
+       if (changed)
                capture_state_changed(state);
 }
 
 void Session::update_signals()
 {
-       assert(device_);
-       assert(capture_state_ == Stopped);
+       if (!device_) {
+               signals_.clear();
+               logic_data_.reset();
+               return;
+       }
+
+       lock_guard<recursive_mutex> lock(data_mutex_);
 
        const shared_ptr<sigrok::Device> sr_dev = device_->device();
        if (!sr_dev) {
@@ -343,39 +404,42 @@ void Session::update_signals()
                signals_.clear();
 
                for (auto channel : sr_dev->channels()) {
+                       shared_ptr<data::SignalBase> signalbase;
                        shared_ptr<view::Signal> signal;
 
                        // Find the channel in the old signals
                        const auto iter = std::find_if(
                                prev_sigs.cbegin(), prev_sigs.cend(),
                                [&](const shared_ptr<view::Signal> &s) {
-                                       return s->channel() == channel;
+                                       return s->base()->channel() == channel;
                                });
                        if (iter != prev_sigs.end()) {
                                // Copy the signal from the old set to the new
                                signal = *iter;
-                               auto logic_signal = dynamic_pointer_cast<
-                                       view::LogicSignal>(signal);
-                               if (logic_signal)
-                                       logic_signal->set_logic_data(
-                                               logic_data_);
                        } else {
                                // Create a new signal
+                               signalbase = shared_ptr<data::SignalBase>(
+                                       new data::SignalBase(channel));
+
                                switch(channel->type()->id()) {
                                case SR_CHANNEL_LOGIC:
+                                       signalbase->set_data(logic_data_);
                                        signal = shared_ptr<view::Signal>(
                                                new view::LogicSignal(*this,
-                                                       device_, channel,
-                                                       logic_data_));
+                                                       device_, signalbase));
+                                       all_signal_data_.insert(logic_data_);
+                                       signalbases_.insert(signalbase);
                                        break;
 
                                case SR_CHANNEL_ANALOG:
                                {
-                                       shared_ptr<data::Analog> data(
-                                               new data::Analog());
+                                       shared_ptr<data::Analog> data(new data::Analog());
+                                       signalbase->set_data(data);
                                        signal = shared_ptr<view::Signal>(
                                                new view::AnalogSignal(
-                                                       *this, channel, data));
+                                                       *this, signalbase));
+                                       all_signal_data_.insert(data);
+                                       signalbases_.insert(signalbase);
                                        break;
                                }
 
@@ -393,47 +457,31 @@ void Session::update_signals()
        signals_changed();
 }
 
-shared_ptr<view::Signal> Session::signal_from_channel(
-       shared_ptr<Channel> channel) const
+shared_ptr<data::SignalBase> Session::signalbase_from_channel(
+       shared_ptr<sigrok::Channel> channel) const
 {
-       lock_guard<boost::shared_mutex> lock(signals_mutex_);
-       for (shared_ptr<view::Signal> sig : signals_) {
+       for (shared_ptr<data::SignalBase> sig : signalbases_) {
                assert(sig);
                if (sig->channel() == channel)
                        return sig;
        }
-       return shared_ptr<view::Signal>();
+       return shared_ptr<data::SignalBase>();
 }
 
-void Session::read_sample_rate(shared_ptr<sigrok::Device> device)
+void Session::sample_thread_proc(function<void (const QString)> error_handler)
 {
-       assert(device);
-       map< const ConfigKey*, set<sigrok::Capability> > keys;
+       assert(error_handler);
 
-       try {
-               keys = device->config_keys(ConfigKey::DEVICE_OPTIONS);
-       } catch (const Error) {}
-
-       const auto iter = keys.find(ConfigKey::SAMPLERATE);
-       cur_samplerate_ = (iter != keys.end() &&
-               (*iter).second.find(sigrok::GET) != (*iter).second.end()) ?
-               VariantBase::cast_dynamic<Variant<guint64>>(
-                       device->config_get(ConfigKey::SAMPLERATE)).get() : 0;
-}
+       if (!device_)
+               return;
 
-void Session::sample_thread_proc(shared_ptr<devices::Device> device,
-       function<void (const QString)> error_handler)
-{
-       assert(device);
-       assert(error_handler);
+       cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 
-       const std::shared_ptr<sigrok::Device> sr_dev = device->device();
-       assert(sr_dev);
-       read_sample_rate(sr_dev);
+       out_of_memory_ = false;
 
        try {
-               device_->session()->start();
-       } catch(Error e) {
+               device_->start();
+       } catch (Error e) {
                error_handler(e.what());
                return;
        }
@@ -445,16 +493,18 @@ void Session::sample_thread_proc(shared_ptr<devices::Device> device,
        set_capture_state(Stopped);
 
        // Confirm that SR_DF_END was received
-       if (cur_logic_segment_)
-       {
+       if (cur_logic_segment_) {
                qDebug("SR_DF_END was not received.");
                assert(0);
        }
+
+       if (out_of_memory_)
+               error_handler(tr("Out of memory, acquisition stopped."));
 }
 
 void Session::feed_in_header()
 {
-       read_sample_rate(device_->device());
+       cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 }
 
 void Session::feed_in_meta(shared_ptr<Meta> meta)
@@ -462,6 +512,11 @@ void Session::feed_in_meta(shared_ptr<Meta> meta)
        for (auto entry : meta->config()) {
                switch (entry.first->id()) {
                case SR_CONF_SAMPLERATE:
+                       // We can't rely on the header to always contain the sample rate,
+                       // so in case it's supplied via a meta packet, we use it.
+                       if (!cur_samplerate_)
+                               cur_samplerate_ = g_variant_get_uint64(entry.second.gobj());
+
                        /// @todo handle samplerate changes
                        break;
                default:
@@ -473,6 +528,30 @@ void Session::feed_in_meta(shared_ptr<Meta> meta)
        signals_changed();
 }
 
+void Session::feed_in_trigger()
+{
+       // The channel containing most samples should be most accurate
+       uint64_t sample_count = 0;
+
+       {
+               shared_lock<shared_mutex> lock(signals_mutex_);
+               for (const shared_ptr<pv::data::SignalData> d : all_signal_data_) {
+                       assert(d);
+                       uint64_t temp_count = 0;
+
+                       const vector< shared_ptr<pv::data::Segment> > segments =
+                               d->segments();
+                       for (const shared_ptr<pv::data::Segment> &s : segments)
+                               temp_count += s->get_sample_count();
+
+                       if (temp_count > sample_count)
+                               sample_count = temp_count;
+               }
+       }
+
+       trigger_event(sample_count / get_samplerate());
+}
+
 void Session::feed_in_frame_begin()
 {
        if (cur_logic_segment_ || !cur_analog_segments_.empty())
@@ -483,35 +562,23 @@ void Session::feed_in_logic(shared_ptr<Logic> logic)
 {
        lock_guard<recursive_mutex> lock(data_mutex_);
 
-       if (!logic_data_)
-       {
-               qDebug() << "Unexpected logic packet";
-               return;
+       const size_t sample_count = logic->data_length() / logic->unit_size();
+
+       if (!logic_data_) {
+               // The only reason logic_data_ would not have been created is
+               // if it was not possible to determine the signals when the
+               // device was created.
+               update_signals();
        }
 
-       if (!cur_logic_segment_)
-       {
+       if (!cur_logic_segment_) {
                // This could be the first packet after a trigger
                set_capture_state(Running);
 
-               // Get sample limit.
-               assert(device_);
-               const std::shared_ptr<sigrok::Device> device =
-                       device_->device();
-               assert(device);
-               const auto keys = device->config_keys(
-                       ConfigKey::DEVICE_OPTIONS);
-               const auto iter = keys.find(ConfigKey::LIMIT_SAMPLES);
-               const uint64_t sample_limit = (iter != keys.end() &&
-                       (*iter).second.find(sigrok::GET) !=
-                       (*iter).second.end()) ?
-                       VariantBase::cast_dynamic<Variant<guint64>>(
-                       device->config_get(ConfigKey::LIMIT_SAMPLES)).get() : 0;
-
                // Create a new data segment
                cur_logic_segment_ = shared_ptr<data::LogicSegment>(
                        new data::LogicSegment(
-                               logic, cur_samplerate_, sample_limit));
+                               logic, cur_samplerate_, sample_count));
                logic_data_->push_segment(cur_logic_segment_);
 
                // @todo Putting this here means that only listeners querying
@@ -519,9 +586,7 @@ void Session::feed_in_logic(shared_ptr<Logic> logic)
                // frame_began is DecoderStack, but in future we need to signal
                // this after both analog and logic sweeps have begun.
                frame_began();
-       }
-       else
-       {
+       } else {
                // Append to the existing data segment
                cur_logic_segment_->append_payload(logic);
        }
@@ -536,11 +601,13 @@ void Session::feed_in_analog(shared_ptr<Analog> analog)
        const vector<shared_ptr<Channel>> channels = analog->channels();
        const unsigned int channel_count = channels.size();
        const size_t sample_count = analog->num_samples() / channel_count;
-       const float *data = analog->data_pointer();
+       const float *data = static_cast<const float *>(analog->data_pointer());
        bool sweep_beginning = false;
 
-       for (auto channel : channels)
-       {
+       if (signals_.empty())
+               update_signals();
+
+       for (auto channel : channels) {
                shared_ptr<data::AnalogSegment> segment;
 
                // Try to get the segment of the channel
@@ -548,39 +615,23 @@ void Session::feed_in_analog(shared_ptr<Analog> analog)
                        iterator iter = cur_analog_segments_.find(channel);
                if (iter != cur_analog_segments_.end())
                        segment = (*iter).second;
-               else
-               {
-                       // If no segment was found, this means we havn't
+               else {
+                       // If no segment was found, this means we haven't
                        // created one yet. i.e. this is the first packet
                        // in the sweep containing this segment.
                        sweep_beginning = true;
 
-                       // Get sample limit.
-                       uint64_t sample_limit;
-                       try {
-                               assert(device_);
-                               const std::shared_ptr<sigrok::Device> device =
-                                       device_->device();
-                               assert(device);
-                               sample_limit = VariantBase::cast_dynamic<Variant<guint64>>(
-                                       device->config_get(ConfigKey::LIMIT_SAMPLES)).get();
-                       } catch (Error) {
-                               sample_limit = 0;
-                       }
-
                        // Create a segment, keep it in the maps of channels
                        segment = shared_ptr<data::AnalogSegment>(
                                new data::AnalogSegment(
-                                       cur_samplerate_, sample_limit));
+                                       cur_samplerate_, sample_count));
                        cur_analog_segments_[channel] = segment;
 
-                       // Find the annalog data associated with the channel
-                       shared_ptr<view::AnalogSignal> sig =
-                               dynamic_pointer_cast<view::AnalogSignal>(
-                                       signal_from_channel(channel));
-                       assert(sig);
+                       // Find the analog data associated with the channel
+                       shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
+                       assert(base);
 
-                       shared_ptr<data::Analog> data(sig->analog_data());
+                       shared_ptr<data::Analog> data(base->analog_data());
                        assert(data);
 
                        // Push the segment into the analog data.
@@ -620,16 +671,30 @@ void Session::data_feed_in(shared_ptr<sigrok::Device> device,
                feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
                break;
 
+       case SR_DF_TRIGGER:
+               feed_in_trigger();
+               break;
+
        case SR_DF_FRAME_BEGIN:
                feed_in_frame_begin();
                break;
 
        case SR_DF_LOGIC:
-               feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
+               try {
+                       feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
+               } catch (std::bad_alloc) {
+                       out_of_memory_ = true;
+                       device_->stop();
+               }
                break;
 
        case SR_DF_ANALOG:
-               feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
+               try {
+                       feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
+               } catch (std::bad_alloc) {
+                       out_of_memory_ = true;
+                       device_->stop();
+               }
                break;
 
        case SR_DF_END: