]> sigrok.org Git - pulseview.git/blobdiff - pv/session.cpp
Fix warning for unused Session::sample_thread_proc() parameter
[pulseview.git] / pv / session.cpp
index 70637437e08b5ad1ea867e58ae4573956cc30bb9..73dd339b60fea95259d6fddc7aace7ec9f3ad0e1 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
@@ -33,6 +41,9 @@
 #include "data/logicsegment.hpp"
 #include "data/decode/decoder.hpp"
 
+#include "devices/hardwaredevice.hpp"
+#include "devices/sessionfile.hpp"
+
 #include "view/analogsignal.hpp"
 #include "view/decodetrace.hpp"
 #include "view/logicsignal.hpp"
@@ -57,6 +68,7 @@ using std::lock_guard;
 using std::list;
 using std::map;
 using std::mutex;
+using std::recursive_mutex;
 using std::set;
 using std::shared_ptr;
 using std::string;
@@ -68,9 +80,7 @@ using sigrok::Channel;
 using sigrok::ChannelType;
 using sigrok::ConfigKey;
 using sigrok::DatafeedCallbackFunction;
-using sigrok::Device;
 using sigrok::Error;
-using sigrok::HardwareDevice;
 using sigrok::Header;
 using sigrok::Logic;
 using sigrok::Meta;
@@ -85,11 +95,9 @@ using Glib::Variant;
 namespace pv {
 Session::Session(DeviceManager &device_manager) :
        device_manager_(device_manager),
-       session_(device_manager.context()->create_session()),
        capture_state_(Stopped),
        cur_samplerate_(0)
 {
-       set_default_device();
 }
 
 Session::~Session()
@@ -108,95 +116,75 @@ const DeviceManager& Session::device_manager() const
        return device_manager_;
 }
 
-const shared_ptr<sigrok::Session>& Session::session() const
+shared_ptr<sigrok::Session> Session::session() const
 {
-       return session_;
+       if (!device_)
+               return shared_ptr<sigrok::Session>();
+       return device_->session();
 }
 
-shared_ptr<Device> Session::device() const
+shared_ptr<devices::Device> Session::device() const
 {
        return device_;
 }
 
-void Session::set_device(shared_ptr<Device> device)
+void Session::set_device(shared_ptr<devices::Device> device)
 {
+       assert(device);
+
        // Ensure we are not capturing before setting the device
        stop_capture();
 
-       // Are we setting a session device?
-       const auto session_device =
-               dynamic_pointer_cast<SessionDevice>(device);
+       if (device_)
+               device_->close();
 
-       // Did we have a session device selected previously?
-       const auto prev_session_device =
-               dynamic_pointer_cast<SessionDevice>(device_);
+       device_.reset();
 
-       if (device_) {
-               session_->remove_datafeed_callbacks();
-               if (!prev_session_device) {
-                       device_->close();
-                       session_->remove_devices();
-               }
+       // 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();
 
-       if (session_device)
-               session_ = session_device->parent();
+       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();
 
-       if (device) {
-               if (!session_device)
-               {
-                       session_ = device_manager_.context()->create_session();
-
-                       try {
-                               device->open();
-                       } catch(const sigrok::Error &e) {
-                               throw QString(e.what());
-                       }
-
-                       session_->add_device(device);
-               }
+       signals_changed();
 
-               device_ = device;
-               session_->add_datafeed_callback([=]
-                       (shared_ptr<Device> device, shared_ptr<Packet> packet) {
-                               data_feed_in(device, packet);
-                       });
-               device_manager_.update_display_name(device);
-               update_signals(device);
-       } else
-               device_ = nullptr;
+       device_ = std::move(device);
+       device_->open();
+       device_->session()->add_datafeed_callback([=]
+               (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
+                       data_feed_in(device, packet);
+               });
 
+       update_signals();
        device_selected();
 }
 
-void Session::set_session_file(const string &name)
-{
-       const shared_ptr<sigrok::Session> session =
-               device_manager_.context()->load_session(name);
-       set_device(session->devices()[0]);
-}
-
 void Session::set_default_device()
 {
-       shared_ptr<HardwareDevice> default_device;
-       const list< shared_ptr<HardwareDevice> > &devices =
+       const list< shared_ptr<devices::HardwareDevice> > &devices =
                device_manager_.devices();
 
-       if (!devices.empty()) {
-               // Fall back to the first device in the list.
-               default_device = devices.front();
-
-               // Try and find the demo device and select that by default
-               for (shared_ptr<HardwareDevice> dev : devices)
-                       if (dev->driver()->name().compare("demo") == 0) {
-                               default_device = dev;
-                               break;
-                       }
+       if (devices.empty())
+               return;
 
-               set_device(default_device);
-       }
+       // Try and find the demo device and select that by default
+       const auto iter = std::find_if(devices.begin(), devices.end(),
+               [] (const shared_ptr<devices::HardwareDevice> &d) {
+                       return d->hardware_device()->driver()->name() ==
+                       "demo"; });
+       set_device((iter == devices.end()) ? devices.front() : *iter);
 }
 
 Session::capture_state Session::get_capture_state() const
@@ -207,59 +195,71 @@ Session::capture_state Session::get_capture_state() const
 
 void Session::start_capture(function<void (const QString)> error_handler)
 {
-       stop_capture();
-
-       // Check that a device instance has been selected.
        if (!device_) {
-               qDebug() << "No device selected";
+               error_handler(tr("No active device set, can't start acquisition."));
                return;
        }
 
+       stop_capture();
+
        // Check that at least one channel is enabled
-       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()
 {
        if (get_capture_state() != Stopped)
-               session_->stop();
+               device_->stop();
 
        // Check that sampling stopped
        if (sampling_thread_.joinable())
                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_;
 }
 
@@ -269,8 +269,7 @@ bool Session::add_decoder(srd_decoder *const dec)
        map<const srd_channel*, shared_ptr<view::LogicSignal> > channels;
        shared_ptr<data::DecoderStack> decoder_stack;
 
-       try
-       {
+       try {
                lock_guard<boost::shared_mutex> lock(signals_mutex_);
 
                // Create the decoder
@@ -279,15 +278,14 @@ 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_)
-                       {
+                       for (shared_ptr<view::Signal> s : signals_) {
                                shared_ptr<view::LogicSignal> l =
                                        dynamic_pointer_cast<view::LogicSignal>(s);
                                if (l && QString::fromUtf8(pdch->name).
@@ -306,9 +304,7 @@ bool Session::add_decoder(srd_decoder *const dec)
                        new view::DecodeTrace(*this, decoder_stack,
                                decode_traces_.size()));
                decode_traces_.push_back(d);
-       }
-       catch(std::runtime_error e)
-       {
+       } catch (std::runtime_error e) {
                return false;
        }
 
@@ -329,8 +325,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;
@@ -340,20 +335,37 @@ 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(shared_ptr<Device> device)
+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) {
+               signals_.clear();
+               logic_data_.reset();
+               return;
+       }
 
        // Detect what data types we will receive
-       auto channels = device->channels();
+       auto channels = sr_dev->channels();
        unsigned int logic_channel_count = std::count_if(
                channels.begin(), channels.end(),
                [] (shared_ptr<Channel> channel) {
@@ -361,7 +373,7 @@ void Session::update_signals(shared_ptr<Device> device)
 
        // Create data containers for the logic data segments
        {
-               lock_guard<mutex> data_lock(data_mutex_);
+               lock_guard<recursive_mutex> data_lock(data_mutex_);
 
                if (logic_channel_count == 0) {
                        logic_data_.reset();
@@ -380,7 +392,7 @@ void Session::update_signals(shared_ptr<Device> device)
                unordered_set< shared_ptr<view::Signal> > prev_sigs(signals_);
                signals_.clear();
 
-               for (auto channel : device->channels()) {
+               for (auto channel : sr_dev->channels()) {
                        shared_ptr<view::Signal> signal;
 
                        // Find the channel in the old signals
@@ -403,8 +415,9 @@ void Session::update_signals(shared_ptr<Device> device)
                                case SR_CHANNEL_LOGIC:
                                        signal = shared_ptr<view::Signal>(
                                                new view::LogicSignal(*this,
-                                                       device, channel,
+                                                       device_, channel,
                                                        logic_data_));
+                                       all_signal_data_.insert(logic_data_);
                                        break;
 
                                case SR_CHANNEL_ANALOG:
@@ -414,6 +427,7 @@ void Session::update_signals(shared_ptr<Device> device)
                                        signal = shared_ptr<view::Signal>(
                                                new view::AnalogSignal(
                                                        *this, channel, data));
+                                       all_signal_data_.insert(data);
                                        break;
                                }
 
@@ -443,58 +457,55 @@ shared_ptr<view::Signal> Session::signal_from_channel(
        return shared_ptr<view::Signal>();
 }
 
-void Session::read_sample_rate(shared_ptr<Device> device)
-{
-       const auto keys = device_->config_keys(ConfigKey::DEVICE_OPTIONS);
-       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;
-}
-
-void Session::sample_thread_proc(shared_ptr<Device> device,
-       function<void (const QString)> error_handler)
+void Session::sample_thread_proc(function<void (const QString)> error_handler)
 {
-       assert(device);
        assert(error_handler);
 
-       read_sample_rate(device);
+       if (!device_)
+               return;
+
+       cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
+
+       out_of_memory_ = false;
 
        try {
-               session_->start();
-       } catch(Error e) {
+               device_->start();
+       } catch (Error e) {
                error_handler(e.what());
                return;
        }
 
-       set_capture_state(session_->trigger() ?
+       set_capture_state(device_->session()->trigger() ?
                AwaitingTrigger : Running);
 
-       session_->run();
+       device_->run();
        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(shared_ptr<Device> device)
+void Session::feed_in_header()
 {
-       read_sample_rate(device);
+       cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
 }
 
-void Session::feed_in_meta(shared_ptr<Device> device,
-       shared_ptr<Meta> meta)
+void Session::feed_in_meta(shared_ptr<Meta> meta)
 {
-       (void)device;
-
        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:
@@ -506,6 +517,30 @@ void Session::feed_in_meta(shared_ptr<Device> device,
        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())
@@ -514,33 +549,25 @@ void Session::feed_in_frame_begin()
 
 void Session::feed_in_logic(shared_ptr<Logic> logic)
 {
-       lock_guard<mutex> lock(data_mutex_);
+       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.
-               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
@@ -548,9 +575,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);
        }
@@ -560,16 +585,18 @@ void Session::feed_in_logic(shared_ptr<Logic> logic)
 
 void Session::feed_in_analog(shared_ptr<Analog> analog)
 {
-       lock_guard<mutex> lock(data_mutex_);
+       lock_guard<recursive_mutex> lock(data_mutex_);
 
        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
@@ -577,29 +604,19 @@ 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 {
-                               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
+                       // Find the analog data associated with the channel
                        shared_ptr<view::AnalogSignal> sig =
                                dynamic_pointer_cast<view::AnalogSignal>(
                                        signal_from_channel(channel));
@@ -627,18 +644,26 @@ void Session::feed_in_analog(shared_ptr<Analog> analog)
        data_received();
 }
 
-void Session::data_feed_in(shared_ptr<Device> device, shared_ptr<Packet> packet)
+void Session::data_feed_in(shared_ptr<sigrok::Device> device,
+       shared_ptr<Packet> packet)
 {
+       (void)device;
+
        assert(device);
+       assert(device == device_->device());
        assert(packet);
 
        switch (packet->type()->id()) {
        case SR_DF_HEADER:
-               feed_in_header(device);
+               feed_in_header();
                break;
 
        case SR_DF_META:
-               feed_in_meta(device, dynamic_pointer_cast<Meta>(packet->payload()));
+               feed_in_meta(dynamic_pointer_cast<Meta>(packet->payload()));
+               break;
+
+       case SR_DF_TRIGGER:
+               feed_in_trigger();
                break;
 
        case SR_DF_FRAME_BEGIN:
@@ -646,17 +671,27 @@ void Session::data_feed_in(shared_ptr<Device> device, shared_ptr<Packet> packet)
                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:
        {
                {
-                       lock_guard<mutex> lock(data_mutex_);
+                       lock_guard<recursive_mutex> lock(data_mutex_);
                        cur_logic_segment_.reset();
                        cur_analog_segments_.clear();
                }