]> sigrok.org Git - pulseview.git/blobdiff - pv/sigsession.cpp
Remove obsolete input module support.
[pulseview.git] / pv / sigsession.cpp
index 8d22296c40e89e57da2ad24ec12aec88112c7be9..ac9c052b3bf9b8d50e66adac02efc670359fac4d 100644 (file)
@@ -25,6 +25,8 @@
 #include "sigsession.h"
 
 #include "devicemanager.h"
+#include "device/device.h"
+#include "device/file.h"
 
 #include "data/analog.h"
 #include "data/analogsnapshot.h"
 #include "view/decodetrace.h"
 #include "view/logicsignal.h"
 
-#include <assert.h>
-
+#include <cassert>
+#include <mutex>
 #include <stdexcept>
 
-#include <boost/foreach.hpp>
-
 #include <sys/stat.h>
 
 #include <QDebug>
 
-using boost::dynamic_pointer_cast;
-using boost::function;
-using boost::lock_guard;
-using boost::mutex;
-using boost::shared_ptr;
+using std::dynamic_pointer_cast;
+using std::function;
+using std::lock_guard;
+using std::mutex;
+using std::list;
 using std::map;
 using std::set;
+using std::shared_ptr;
 using std::string;
 using std::vector;
 
@@ -62,97 +63,101 @@ namespace pv {
 // TODO: This should not be necessary
 SigSession* SigSession::_session = NULL;
 
+// TODO: This should not be necessary
+struct sr_session *SigSession::_sr_session = NULL;
+
 SigSession::SigSession(DeviceManager &device_manager) :
        _device_manager(device_manager),
-       _sdi(NULL),
        _capture_state(Stopped)
 {
        // TODO: This should not be necessary
        _session = this;
+
+       set_default_device();
 }
 
 SigSession::~SigSession()
 {
-       stop_capture();
+       using pv::device::Device;
 
-       _sampling_thread.join();
+       // Stop and join to the thread
+       stop_capture();
 
-       if (_sdi)
-               _device_manager.release_device(_sdi);
-       _sdi = NULL;
+       if (_dev_inst)
+               _dev_inst->release();
 
        // TODO: This should not be necessary
        _session = NULL;
 }
 
-struct sr_dev_inst* SigSession::get_device() const
+shared_ptr<device::DevInst> SigSession::get_device() const
 {
-       return _sdi;
+       return _dev_inst;
 }
 
-void SigSession::set_device(struct sr_dev_inst *sdi)
+void SigSession::set_device(
+       shared_ptr<device::DevInst> dev_inst) throw(QString)
 {
+       using pv::device::Device;
+
+       if (!dev_inst)
+               return;
+
        // Ensure we are not capturing before setting the device
        stop_capture();
 
-       if (_sdi)
-               _device_manager.release_device(_sdi);
-       if (sdi)
-               _device_manager.use_device(sdi, this);
-       _sdi = sdi;
-       update_signals(sdi);
-}
+       if (_dev_inst) {
+               sr_session_datafeed_callback_remove_all(_sr_session);
+               _dev_inst->release();
+       }
 
-void SigSession::release_device(struct sr_dev_inst *sdi)
-{
-       (void)sdi;
+       _dev_inst = dev_inst;
+       _decode_traces.clear();
 
-       assert(_capture_state == Stopped);
-       _sdi = NULL;
-       update_signals(NULL);
+       if (dev_inst) {
+               dev_inst->use(this);
+               sr_session_datafeed_callback_add(_sr_session, data_feed_in_proc, NULL);
+               update_signals(dev_inst);
+       }
 }
 
-void SigSession::load_file(const string &name,
-       function<void (const QString)> error_handler)
+void SigSession::set_file(const string &name) throw(QString)
 {
-       stop_capture();
-
-       if (sr_session_load(name.c_str()) == SR_OK) {
-               GSList *devlist = NULL;
-               sr_session_dev_list(&devlist);
-
-               if (!devlist || !devlist->data ||
-                       sr_session_start() != SR_OK) {
-                       error_handler(tr("Failed to start session."));
-                       return;
-               }
-
-               sr_dev_inst *const sdi = (sr_dev_inst*)devlist->data;
-               g_slist_free(devlist);
-
-               _decode_traces.clear();
-               update_signals(sdi);
-               read_sample_rate(sdi);
-
-               _sampling_thread = boost::thread(
-                       &SigSession::load_session_thread_proc, this,
-                       error_handler);
+       // Deselect the old device, because file type detection in File::create
+       // destroys the old session inside libsigrok.
+       set_device(shared_ptr<device::DevInst>());
+       set_device(shared_ptr<device::DevInst>(device::File::create(name)));
+}
 
-       } else {
-               sr_input *in = NULL;
+void SigSession::set_default_device()
+{
+       shared_ptr<pv::device::DevInst> default_device;
+       const list< shared_ptr<device::Device> > &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<pv::device::Device> dev : devices)
+                       if (strcmp(dev->dev_inst()->driver->name,
+                               "demo") == 0) {
+                               default_device = dev;
+                               break;
+                       }
+       }
 
-               if (!(in = load_input_file_format(name.c_str(),
-                       error_handler)))
-                       return;
+       set_device(default_device);
+}
 
-               _decode_traces.clear();
-               update_signals(in->sdi);
-               read_sample_rate(in->sdi);
+void SigSession::release_device(device::DevInst *dev_inst)
+{
+       (void)dev_inst;
+       assert(_dev_inst.get() == dev_inst);
 
-               _sampling_thread = boost::thread(
-                       &SigSession::load_input_thread_proc, this,
-                       name, in, error_handler);
-       }
+       assert(_capture_state == Stopped);
+       _dev_inst = shared_ptr<device::DevInst>();
 }
 
 SigSession::capture_state SigSession::get_capture_state() const
@@ -161,53 +166,53 @@ SigSession::capture_state SigSession::get_capture_state() const
        return _capture_state;
 }
 
-void SigSession::start_capture(uint64_t record_length,
-       function<void (const QString)> error_handler)
+void SigSession::start_capture(function<void (const QString)> error_handler)
 {
        stop_capture();
 
        // Check that a device instance has been selected.
-       if (!_sdi) {
+       if (!_dev_inst) {
                qDebug() << "No device selected";
                return;
        }
 
+       assert(_dev_inst->dev_inst());
+
        // Check that at least one probe is enabled
        const GSList *l;
-       for (l = _sdi->probes; l; l = l->next) {
-               sr_probe *const probe = (sr_probe*)l->data;
+       for (l = _dev_inst->dev_inst()->channels; l; l = l->next) {
+               sr_channel *const probe = (sr_channel*)l->data;
                assert(probe);
                if (probe->enabled)
                        break;
        }
 
        if (!l) {
-               error_handler(tr("No probes enabled."));
+               error_handler(tr("No channels enabled."));
                return;
        }
 
        // Begin the session
-       _sampling_thread = boost::thread(
-               &SigSession::sample_thread_proc, this, _sdi,
-               record_length, error_handler);
+       _sampling_thread = std::thread(
+               &SigSession::sample_thread_proc, this, _dev_inst,
+                       error_handler);
 }
 
 void SigSession::stop_capture()
 {
-       if (get_capture_state() == Stopped)
-               return;
-
-       sr_session_stop();
+       if (get_capture_state() != Stopped)
+               sr_session_stop(_sr_session);
 
        // Check that sampling stopped
-       _sampling_thread.join();
+       if (_sampling_thread.joinable())
+               _sampling_thread.join();
 }
 
 set< shared_ptr<data::SignalData> > SigSession::get_data() const
 {
        lock_guard<mutex> lock(_signals_mutex);
        set< shared_ptr<data::SignalData> > data;
-       BOOST_FOREACH(const shared_ptr<view::Signal> sig, _signals) {
+       for (const shared_ptr<view::Signal> sig : _signals) {
                assert(sig);
                data.insert(sig->data());
        }
@@ -224,7 +229,7 @@ vector< shared_ptr<view::Signal> > SigSession::get_signals() const
 #ifdef ENABLE_DECODE
 bool SigSession::add_decoder(srd_decoder *const dec)
 {
-       map<const srd_probe*, shared_ptr<view::LogicSignal> > probes;
+       map<const srd_channel*, shared_ptr<view::LogicSignal> > probes;
        shared_ptr<data::DecoderStack> decoder_stack;
 
        try
@@ -233,22 +238,26 @@ bool SigSession::add_decoder(srd_decoder *const dec)
 
                // Create the decoder
                decoder_stack = shared_ptr<data::DecoderStack>(
-                       new data::DecoderStack(dec));
+                       new data::DecoderStack(*this, dec));
+
+               // Make a list of all the probes
+               std::vector<const srd_channel*> all_probes;
+               for(const GSList *i = dec->channels; i; i = i->next)
+                       all_probes.push_back((const srd_channel*)i->data);
+               for(const GSList *i = dec->opt_channels; i; i = i->next)
+                       all_probes.push_back((const srd_channel*)i->data);
 
                // Auto select the initial probes
-               for(const GSList *i = dec->probes; i; i = i->next)
-               {
-                       const srd_probe *const probe = (const srd_probe*)i->data;
-                       BOOST_FOREACH(shared_ptr<view::Signal> s, _signals)
+               for (const srd_channel *pdch : all_probes)
+                       for (shared_ptr<view::Signal> s : _signals)
                        {
                                shared_ptr<view::LogicSignal> l =
                                        dynamic_pointer_cast<view::LogicSignal>(s);
-                               if (l && QString::fromUtf8(probe->name).
+                               if (l && QString::fromUtf8(pdch->name).
                                        toLower().contains(
                                        l->get_name().toLower()))
-                                       probes[probe] = l;
+                                       probes[pdch] = l;
                        }
-               }
 
                assert(decoder_stack);
                assert(!decoder_stack->stack().empty());
@@ -282,10 +291,7 @@ vector< shared_ptr<view::DecodeTrace> > SigSession::get_decode_signals() const
 
 void SigSession::remove_decode_signal(view::DecodeTrace *signal)
 {
-       for (vector< shared_ptr<view::DecodeTrace> >::iterator i =
-               _decode_traces.begin();
-               i != _decode_traces.end();
-               i++)
+       for (auto i = _decode_traces.begin(); i != _decode_traces.end(); i++)
                if ((*i).get() == signal)
                {
                        _decode_traces.erase(i);
@@ -304,84 +310,9 @@ void SigSession::set_capture_state(capture_state state)
                capture_state_changed(state);
 }
 
-/**
- * Attempts to autodetect the format. Failing that
- * @param filename The filename of the input file.
- * @return A pointer to the 'struct sr_input_format' that should be used,
- *         or NULL if no input format was selected or auto-detected.
- */
-sr_input_format* SigSession::determine_input_file_format(
-       const string &filename)
-{
-       int i;
-
-       /* If there are no input formats, return NULL right away. */
-       sr_input_format *const *const inputs = sr_input_list();
-       if (!inputs) {
-               g_critical("No supported input formats available.");
-               return NULL;
-       }
-
-       /* Otherwise, try to find an input module that can handle this file. */
-       for (i = 0; inputs[i]; i++) {
-               if (inputs[i]->format_match(filename.c_str()))
-                       break;
-       }
-
-       /* Return NULL if no input module wanted to touch this. */
-       if (!inputs[i]) {
-               g_critical("Error: no matching input module found.");
-               return NULL;
-       }
-
-       return inputs[i];
-}
-
-sr_input* SigSession::load_input_file_format(const string &filename,
-       function<void (const QString)> error_handler,
-       sr_input_format *format)
-{
-       struct stat st;
-       sr_input *in;
-
-       if (!format && !(format =
-               determine_input_file_format(filename.c_str()))) {
-               /* The exact cause was already logged. */
-               return NULL;
-       }
-
-       if (stat(filename.c_str(), &st) == -1) {
-               error_handler(tr("Failed to load file"));
-               return NULL;
-       }
-
-       /* Initialize the input module. */
-       if (!(in = new sr_input)) {
-               qDebug("Failed to allocate input module.\n");
-               return NULL;
-       }
-
-       in->format = format;
-       in->param = NULL;
-       if (in->format->init &&
-               in->format->init(in, filename.c_str()) != SR_OK) {
-               qDebug("Input format init failed.\n");
-               return NULL;
-       }
-
-       sr_session_new();
-
-       if (sr_session_dev_add(in->sdi) != SR_OK) {
-               qDebug("Failed to use device.\n");
-               sr_session_destroy();
-               return NULL;
-       }
-
-       return in;
-}
-
-void SigSession::update_signals(const sr_dev_inst *const sdi)
+void SigSession::update_signals(shared_ptr<device::DevInst> dev_inst)
 {
+       assert(dev_inst);
        assert(_capture_state == Stopped);
 
        unsigned int logic_probe_count = 0;
@@ -390,14 +321,16 @@ void SigSession::update_signals(const sr_dev_inst *const sdi)
        _decode_traces.clear();
 
        // Detect what data types we will receive
-       if(sdi) {
-               for (const GSList *l = sdi->probes; l; l = l->next) {
-                       const sr_probe *const probe = (const sr_probe *)l->data;
+       if(dev_inst) {
+               assert(dev_inst->dev_inst());
+               for (const GSList *l = dev_inst->dev_inst()->channels;
+                       l; l = l->next) {
+                       const sr_channel *const probe = (const sr_channel *)l->data;
                        if (!probe->enabled)
                                continue;
 
                        switch(probe->type) {
-                       case SR_PROBE_LOGIC:
+                       case SR_CHANNEL_LOGIC:
                                logic_probe_count++;
                                break;
                        }
@@ -422,28 +355,30 @@ void SigSession::update_signals(const sr_dev_inst *const sdi)
 
                _signals.clear();
 
-               if(!sdi)
+               if(!dev_inst)
                        break;
 
-               for (const GSList *l = sdi->probes; l; l = l->next) {
+               assert(dev_inst->dev_inst());
+               for (const GSList *l = dev_inst->dev_inst()->channels;
+                       l; l = l->next) {
                        shared_ptr<view::Signal> signal;
-                       sr_probe *const probe = (sr_probe *)l->data;
+                       sr_channel *const probe = (sr_channel *)l->data;
                        assert(probe);
 
                        switch(probe->type) {
-                       case SR_PROBE_LOGIC:
+                       case SR_CHANNEL_LOGIC:
                                signal = shared_ptr<view::Signal>(
-                                       new view::LogicSignal(*this, probe,
-                                               _logic_data));
+                                       new view::LogicSignal(dev_inst,
+                                               probe, _logic_data));
                                break;
 
-                       case SR_PROBE_ANALOG:
+                       case SR_CHANNEL_ANALOG:
                        {
                                shared_ptr<data::Analog> data(
                                        new data::Analog());
                                signal = shared_ptr<view::Signal>(
-                                       new view::AnalogSignal(*this, probe,
-                                               data));
+                                       new view::AnalogSignal(dev_inst,
+                                               probe, data));
                                break;
                        }
 
@@ -461,24 +396,11 @@ void SigSession::update_signals(const sr_dev_inst *const sdi)
        signals_changed();
 }
 
-bool SigSession::is_trigger_enabled() const
-{
-       assert(_sdi);
-       for (const GSList *l = _sdi->probes; l; l = l->next) {
-               const sr_probe *const p = (const sr_probe *)l->data;
-               assert(p);
-               if (p->trigger && p->trigger[0] != '\0')
-                       return true;
-       }
-
-       return false;
-}
-
 shared_ptr<view::Signal> SigSession::signal_from_probe(
-       const sr_probe *probe) const
+       const sr_channel *probe) const
 {
        lock_guard<mutex> lock(_signals_mutex);
-       BOOST_FOREACH(shared_ptr<view::Signal> sig, _signals) {
+       for (shared_ptr<view::Signal> sig : _signals) {
                assert(sig);
                if (sig->probe() == probe)
                        return sig;
@@ -507,90 +429,32 @@ void SigSession::read_sample_rate(const sr_dev_inst *const sdi)
 
        // Set the sample rate of all data
        const set< shared_ptr<data::SignalData> > data_set = get_data();
-       BOOST_FOREACH(shared_ptr<data::SignalData> data, data_set) {
+       for (shared_ptr<data::SignalData> data : data_set) {
                assert(data);
                data->set_samplerate(sample_rate);
        }
 }
 
-void SigSession::load_session_thread_proc(
+void SigSession::sample_thread_proc(shared_ptr<device::DevInst> dev_inst,
        function<void (const QString)> error_handler)
 {
-       (void)error_handler;
-
-       sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
-
-       set_capture_state(Running);
-
-       sr_session_run();
-
-       sr_session_destroy();
-       set_capture_state(Stopped);
-
-       // Confirm that SR_DF_END was received
-       assert(!_cur_logic_snapshot);
-       assert(_cur_analog_snapshots.empty());
-}
-
-void SigSession::load_input_thread_proc(const string name,
-       sr_input *in, function<void (const QString)> error_handler)
-{
-       (void)error_handler;
-
-       assert(in);
-       assert(in->format);
-
-       sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
-
-       set_capture_state(Running);
-
-       in->format->loadfile(in, name.c_str());
-
-       sr_session_destroy();
-       set_capture_state(Stopped);
-
-       // Confirm that SR_DF_END was received
-       assert(!_cur_logic_snapshot);
-       assert(_cur_analog_snapshots.empty());
-
-       delete in;
-}
-
-void SigSession::sample_thread_proc(struct sr_dev_inst *sdi,
-       uint64_t record_length,
-       function<void (const QString)> error_handler)
-{
-       assert(sdi);
+       assert(dev_inst);
+       assert(dev_inst->dev_inst());
        assert(error_handler);
 
-       sr_session_new();
-       sr_session_datafeed_callback_add(data_feed_in_proc, NULL);
-
-       if (sr_session_dev_add(sdi) != SR_OK) {
-               error_handler(tr("Failed to use device."));
-               sr_session_destroy();
-               return;
-       }
-
-       // Set the sample limit
-       if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES,
-               g_variant_new_uint64(record_length)) != SR_OK) {
-               error_handler(tr("Failed to configure "
-                       "time-based sample limit."));
-               sr_session_destroy();
-               return;
-       }
+       read_sample_rate(dev_inst->dev_inst());
 
-       if (sr_session_start() != SR_OK) {
-               error_handler(tr("Failed to start session."));
+       try {
+               dev_inst->start();
+       } catch(const QString e) {
+               error_handler(e);
                return;
        }
 
-       set_capture_state(is_trigger_enabled() ? AwaitingTrigger : Running);
-
-       sr_session_run();
-       sr_session_destroy();
+       set_capture_state(sr_session_trigger_get(_sr_session) ?
+               AwaitingTrigger : Running);
 
+       dev_inst->run();
        set_capture_state(Stopped);
 
        // Confirm that SR_DF_END was received
@@ -627,6 +491,12 @@ void SigSession::feed_in_meta(const sr_dev_inst *sdi,
        signals_changed();
 }
 
+void SigSession::feed_in_frame_begin()
+{
+       if (_cur_logic_snapshot || !_cur_analog_snapshots.empty())
+               frame_began();
+}
+
 void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
 {
        lock_guard<mutex> lock(_data_mutex);
@@ -644,8 +514,14 @@ void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
 
                // Create a new data snapshot
                _cur_logic_snapshot = shared_ptr<data::LogicSnapshot>(
-                       new data::LogicSnapshot(logic));
+                       new data::LogicSnapshot(logic, _dev_inst->get_sample_limit()));
                _logic_data->push_snapshot(_cur_logic_snapshot);
+
+               // @todo Putting this here means that only listeners querying
+               // for logic will be notified. Currently the only user of
+               // frame_began is DecoderStack, but in future we need to signal
+               // this after both analog and logic sweeps have begun.
+               frame_began();
        }
        else
        {
@@ -653,27 +529,27 @@ void SigSession::feed_in_logic(const sr_datafeed_logic &logic)
                _cur_logic_snapshot->append_payload(logic);
        }
 
-       data_updated();
+       data_received();
 }
 
 void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
 {
        lock_guard<mutex> lock(_data_mutex);
 
-       const unsigned int probe_count = g_slist_length(analog.probes);
+       const unsigned int probe_count = g_slist_length(analog.channels);
        const size_t sample_count = analog.num_samples / probe_count;
        const float *data = analog.data;
        bool sweep_beginning = false;
 
-       for (GSList *p = analog.probes; p; p = p->next)
+       for (GSList *p = analog.channels; p; p = p->next)
        {
                shared_ptr<data::AnalogSnapshot> snapshot;
 
-               sr_probe *const probe = (sr_probe*)p->data;
+               sr_channel *const probe = (sr_channel*)p->data;
                assert(probe);
 
                // Try to get the snapshot of the probe
-               const map< const sr_probe*, shared_ptr<data::AnalogSnapshot> >::
+               const map< const sr_channel*, shared_ptr<data::AnalogSnapshot> >::
                        iterator iter = _cur_analog_snapshots.find(probe);
                if (iter != _cur_analog_snapshots.end())
                        snapshot = (*iter).second;
@@ -686,7 +562,7 @@ void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
 
                        // Create a snapshot, keep it in the maps of probes
                        snapshot = shared_ptr<data::AnalogSnapshot>(
-                               new data::AnalogSnapshot());
+                               new data::AnalogSnapshot(_dev_inst->get_sample_limit()));
                        _cur_analog_snapshots[probe] = snapshot;
 
                        // Find the annalog data associated with the probe
@@ -714,7 +590,7 @@ void SigSession::feed_in_analog(const sr_datafeed_analog &analog)
                set_capture_state(Running);
        }
 
-       data_updated();
+       data_received();
 }
 
 void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
@@ -734,6 +610,10 @@ void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
                        *(const sr_datafeed_meta*)packet->payload);
                break;
 
+       case SR_DF_FRAME_BEGIN:
+               feed_in_frame_begin();
+               break;
+
        case SR_DF_LOGIC:
                assert(packet->payload);
                feed_in_logic(*(const sr_datafeed_logic*)packet->payload);
@@ -751,7 +631,7 @@ void SigSession::data_feed_in(const struct sr_dev_inst *sdi,
                        _cur_logic_snapshot.reset();
                        _cur_analog_snapshots.clear();
                }
-               data_updated();
+               frame_ended();
                break;
        }
        }